tksbrokerapi.TKSBrokerAPI

   1# -*- coding: utf-8 -*-
   2# Author: Timur Gilmullin
   3
   4"""
   5**TKSBrokerAPI** is the trading platform for automation and simplifying the implementation of trading scenarios,
   6as well as working with Tinkoff Invest API server via the REST protocol. The TKSBrokerAPI platform may be used in two ways:
   7from the console, it has a rich keys and commands, or you can use it as Python module with `python import`.
   8
   9TKSBrokerAPI allows you to automate routine trading operations and implement your trading scenarios, or just receive
  10the necessary information from the broker. It is easy enough to integrate into various CI/CD automation systems.
  11
  12- **Open account for trading:** http://tinkoff.ru/sl/AaX1Et1omnH
  13- **TKSBrokerAPI module documentation:** https://tim55667757.github.io/TKSBrokerAPI/docs/tksbrokerapi/TKSBrokerAPI.html
  14- **See CLI examples:** https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md#Usage-examples
  15- **Used constants are in the TKSEnums module:** https://tim55667757.github.io/TKSBrokerAPI/docs/tksbrokerapi/TKSEnums.html
  16- **About Tinkoff Invest API:** https://tinkoff.github.io/investAPI/
  17- **Tinkoff Invest API documentation:** https://tinkoff.github.io/investAPI/swagger-ui/
  18"""
  19
  20# Copyright (c) 2022 Gilmillin Timur Mansurovich
  21#
  22# Licensed under the Apache License, Version 2.0 (the "License");
  23# you may not use this file except in compliance with the License.
  24# You may obtain a copy of the License at
  25#
  26#     http://www.apache.org/licenses/LICENSE-2.0
  27#
  28# Unless required by applicable law or agreed to in writing, software
  29# distributed under the License is distributed on an "AS IS" BASIS,
  30# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  31# See the License for the specific language governing permissions and
  32# limitations under the License.
  33
  34
  35import sys
  36import os
  37from argparse import ArgumentParser
  38from importlib.metadata import version
  39
  40from dateutil.tz import tzlocal
  41from time import sleep
  42
  43import re
  44import json
  45import requests
  46import traceback as tb
  47from typing import Union
  48
  49from multiprocessing import cpu_count, Lock
  50from multiprocessing.pool import ThreadPool
  51import pandas as pd
  52
  53from mako.template import Template  # Mako Templates for Python (https://www.makotemplates.org/). Mako is a template library provides simple syntax and maximum performance.
  54from Templates import *  # Some html-templates used by reporting methods in TKSBrokerAPI module
  55from TKSEnums import *  # A lot of constants from enums sections: https://tinkoff.github.io/investAPI/swagger-ui/
  56from TradeRoutines import *  # This library contains some methods used by trade scenarios implemented with TKSBrokerAPI module
  57
  58from pricegenerator.PriceGenerator import PriceGenerator, uLogger  # This module has a lot of instruments to work with candles data (https://github.com/Tim55667757/PriceGenerator)
  59from pricegenerator.UniLogger import DisableLogger as PGDisLog  # Method for disable log from PriceGenerator
  60
  61import UniLogger as uLog  # Logger for TKSBrokerAPI
  62
  63
  64# --- Common technical parameters:
  65
  66PGDisLog(uLogger.handlers[0])  # Disable 3-rd party logging from PriceGenerator
  67uLogger = uLog.UniLogger  # init logger for TKSBrokerAPI
  68uLogger.level = 10  # debug level by default for TKSBrokerAPI module
  69uLogger.handlers[0].level = 20  # info level by default for STDOUT of TKSBrokerAPI module
  70
  71__version__ = "1.6"  # The "major.minor" version setup here, but build number define at the build-server only
  72
  73CPU_COUNT = cpu_count()  # host's real CPU count
  74CPU_USAGES = CPU_COUNT - 1 if CPU_COUNT > 1 else 1  # how many CPUs will be used for parallel calculations
  75
  76
  77class TinkoffBrokerServer:
  78    """
  79    This class implements methods to work with Tinkoff broker server.
  80
  81    Examples to work with API: https://tinkoff.github.io/investAPI/swagger-ui/
  82
  83    About `token`: https://tinkoff.github.io/investAPI/token/
  84    """
  85    def __init__(self, token: str, accountId: str = None, useCache: bool = True, defaultCache: str = "dump.json") -> None:
  86        """
  87        Main class init.
  88
  89        :param token: Bearer token for Tinkoff Invest API. It can be set from environment variable `TKS_API_TOKEN`.
  90        :param accountId: string with numeric user account ID in Tinkoff Broker. It can be found in broker's reports.
  91                          Also, this variable can be set from environment variable `TKS_ACCOUNT_ID`.
  92        :param useCache: use default cache file with raw data to use instead of `iList`.
  93                         True by default. Cache is auto-update if new day has come.
  94                         If you don't want to use cache and always updates raw data then set `useCache=False`.
  95        :param defaultCache: path to default cache file. `dump.json` by default.
  96        """
  97        if token is None or not token:
  98            try:
  99                self.token = r"{}".format(os.environ["TKS_API_TOKEN"])
 100                uLogger.debug("Bearer token for Tinkoff OpenAPI set up from environment variable `TKS_API_TOKEN`. See https://tinkoff.github.io/investAPI/token/")
 101
 102            except KeyError:
 103                uLogger.error("`--token` key or environment variable `TKS_API_TOKEN` is required! See https://tinkoff.github.io/investAPI/token/")
 104                raise Exception("Token required")
 105
 106        else:
 107            self.token = token  # highly priority than environment variable 'TKS_API_TOKEN'
 108            uLogger.debug("Bearer token for Tinkoff OpenAPI set up from class variable `token`")
 109
 110        if accountId is None or not accountId:
 111            try:
 112                self.accountId = r"{}".format(os.environ["TKS_ACCOUNT_ID"])
 113                uLogger.debug("Main account ID [{}] set up from environment variable `TKS_ACCOUNT_ID`".format(self.accountId))
 114
 115            except KeyError:
 116                uLogger.warning("`--account-id` key or environment variable `TKS_ACCOUNT_ID` undefined! Some of operations may be unavailable (overview, trading etc).")
 117
 118        else:
 119            self.accountId = accountId  # highly priority than environment variable 'TKS_ACCOUNT_ID'
 120            uLogger.debug("Main account ID [{}] set up from class variable `accountId`".format(self.accountId))
 121
 122        self.version = __version__  # duplicate here used TKSBrokerAPI main version
 123        """Current TKSBrokerAPI version: major.minor, but the build number define at the build-server only.
 124
 125        Latest version: https://pypi.org/project/tksbrokerapi/
 126        """
 127
 128        self.__lock = Lock()  # initialize multiprocessing mutex lock
 129
 130        self.aliases = TKS_TICKER_ALIASES
 131        """Some aliases instead official tickers.
 132
 133        See also: `TKSEnums.TKS_TICKER_ALIASES`
 134        """
 135
 136        self.aliasesKeys = self.aliases.keys()  # re-calc only first time at class init
 137
 138        self.exclude = TKS_TICKERS_OR_FIGI_EXCLUDED  # some tickers or FIGIs raised exception earlier when it sends to server, that is why we exclude there
 139
 140        self._ticker = ""
 141        """String with ticker, e.g. `GOOGL`. Tickers may be upper case only.
 142
 143        Use alias for `USD000UTSTOM` simple as `USD`, `EUR_RUB__TOM` as `EUR` etc.
 144        More tickers aliases here: `TKSEnums.TKS_TICKER_ALIASES`.
 145
 146        See also: `SearchByTicker()`, `SearchInstruments()`.
 147        """
 148
 149        self._figi = ""
 150        """String with FIGI, e.g. ticker `GOOGL` has FIGI `BBG009S39JX6`. FIGIs may be upper case only.
 151
 152        See also: `SearchByFIGI()`, `SearchInstruments()`.
 153        """
 154
 155        self.depth = 1
 156        """Depth of Market (DOM) can be >= 1. Default: 1. It used with `--price` key to showing DOM with current prices for givens ticker or FIGI.
 157
 158        See also: `GetCurrentPrices()`.
 159        """
 160
 161        self.server = r"https://invest-public-api.tinkoff.ru/rest"
 162        """Tinkoff REST API server for real trade operations. Default: https://invest-public-api.tinkoff.ru/rest
 163
 164        See also: API method https://tinkoff.github.io/investAPI/#tinkoff-invest-api_1 and `SendAPIRequest()`.
 165        """
 166
 167        uLogger.debug("Broker API server: {}".format(self.server))
 168
 169        self.timeout = 15
 170        """Server operations timeout in seconds. Default: `15`.
 171
 172        See also: `SendAPIRequest()`.
 173        """
 174
 175        self.headers = {
 176            "Content-Type": "application/json",
 177            "accept": "application/json",
 178            "Authorization": "Bearer {}".format(self.token),
 179            "x-app-name": "Tim55667757.TKSBrokerAPI",
 180        }
 181        """Headers which send in every request to broker server. Please, do not change it! Default: `{"Content-Type": "application/json", "accept": "application/json", "Authorization": "Bearer {your_token}"}`.
 182
 183        See also: `SendAPIRequest()`.
 184        """
 185
 186        self.body = None
 187        """Request body which send to broker server. Default: `None`.
 188
 189        See also: `SendAPIRequest()`.
 190        """
 191
 192        self.moreDebug = False
 193        """Enables more debug information in this class, such as net request and response headers in all methods. `False` by default."""
 194
 195        self.useHTMLReports = False
 196        """
 197        If `True` then TKSBrokerAPI generate also HTML reports from Markdown. `False` by default.
 198        
 199        See also: Mako Templates for Python (https://www.makotemplates.org/). Mako is a template library provides simple syntax and maximum performance.
 200        """
 201
 202        self.historyFile = None
 203        """Full path to the output file where history candles will be saved or updated. Default: `None`, it mean that returns only Pandas DataFrame.
 204
 205        See also: `History()`.
 206        """
 207
 208        self.htmlHistoryFile = "index.html"
 209        """Full path to the html file where rendered candles chart stored. Default: `index.html`.
 210
 211        See also: `ShowHistoryChart()`.
 212        """
 213
 214        self.instrumentsFile = "instruments.md"
 215        """Filename where full available to user instruments list will be saved. Default: `instruments.md`.
 216
 217        See also: `ShowInstrumentsInfo()`.
 218        """
 219
 220        self.searchResultsFile = "search-results.md"
 221        """Filename with all found instruments searched by part of its ticker, FIGI or name. Default: `search-results.md`.
 222
 223        See also: `SearchInstruments()`.
 224        """
 225
 226        self.pricesFile = "prices.md"
 227        """Filename where prices of selected instruments will be saved. Default: `prices.md`.
 228
 229        See also: `GetListOfPrices()`.
 230        """
 231
 232        self.infoFile = "info.md"
 233        """Filename where prices of selected instruments will be saved. Default: `prices.md`.
 234
 235        See also: `ShowInstrumentsInfo()`, `RequestBondCoupons()` and `RequestTradingStatus()`.
 236        """
 237
 238        self.bondsXLSXFile = "ext-bonds.xlsx"
 239        """Filename where wider Pandas DataFrame with more information about bonds: main info, current prices, 
 240        bonds payment calendar, some statistics will be stored. Default: `ext-bonds.xlsx`.
 241
 242        See also: `ExtendBondsData()`.
 243        """
 244
 245        self.calendarFile = "calendar.md"
 246        """Filename where bonds payment calendar will be saved. Default: `calendar.md`.
 247        
 248        Pandas dataframe with only bonds payment calendar also will be stored to default file `calendar.xlsx`.
 249
 250        See also: `CreateBondsCalendar()`, `ShowBondsCalendar()`, `ShowInstrumentInfo()`, `RequestBondCoupons()` and `ExtendBondsData()`.
 251        """
 252
 253        self.overviewFile = "overview.md"
 254        """Filename where current portfolio, open trades and orders will be saved. Default: `overview.md`.
 255
 256        See also: `Overview()`, `RequestPortfolio()`, `RequestPositions()`, `RequestPendingOrders()` and `RequestStopOrders()`.
 257        """
 258
 259        self.overviewDigestFile = "overview-digest.md"
 260        """Filename where short digest of the portfolio status will be saved. Default: `overview-digest.md`.
 261
 262        See also: `Overview()` with parameter `details="digest"`.
 263        """
 264
 265        self.overviewPositionsFile = "overview-positions.md"
 266        """Filename where only open positions, without everything else will be saved. Default: `overview-positions.md`.
 267
 268        See also: `Overview()` with parameter `details="positions"`.
 269        """
 270
 271        self.overviewOrdersFile = "overview-orders.md"
 272        """Filename where open limits and stop orders will be saved. Default: `overview-orders.md`.
 273
 274        See also: `Overview()` with parameter `details="orders"`.
 275        """
 276
 277        self.overviewAnalyticsFile = "overview-analytics.md"
 278        """Filename where only the analytics section and the distribution of the portfolio by various categories will be saved. Default: `overview-analytics.md`.
 279
 280        See also: `Overview()` with parameter `details="analytics"`.
 281        """
 282
 283        self.overviewBondsCalendarFile = "overview-calendar.md"
 284        """Filename where only the bonds calendar section will be saved. Default: `overview-calendar.md`.
 285
 286        See also: `Overview()` with parameter `details="calendar"`.
 287        """
 288
 289        self.reportFile = "deals.md"
 290        """Filename where history of deals and trade statistics will be saved. Default: `deals.md`.
 291
 292        See also: `Deals()`.
 293        """
 294
 295        self.withdrawalLimitsFile = "limits.md"
 296        """Filename where table of funds available for withdrawal will be saved. Default: `limits.md`.
 297
 298        See also: `OverviewLimits()` and `RequestLimits()`.
 299        """
 300
 301        self.userInfoFile = "user-info.md"
 302        """Filename where all available user's data (`accountId`s, common user information, margin status and tariff connections limit) will be saved. Default: `user-info.md`.
 303
 304        See also: `OverviewUserInfo()`, `RequestAccounts()`, `RequestUserInfo()`, `RequestMarginStatus()` and `RequestTariffLimits()`.
 305        """
 306
 307        self.userAccountsFile = "accounts.md"
 308        """Filename where simple table with all available user accounts (`accountId`s) will be saved. Default: `accounts.md`.
 309
 310        See also: `OverviewAccounts()`, `RequestAccounts()`.
 311        """
 312
 313        self.iListDumpFile = "dump.json" if defaultCache is None or not isinstance(defaultCache, str) or not defaultCache else defaultCache
 314        """Filename where raw data about shares, currencies, bonds, etfs and futures will be stored. Default: `dump.json`.
 315
 316        Pandas dataframe with raw instruments data also will be stored to default file `dump.xlsx`.
 317
 318        See also: `DumpInstruments()` and `DumpInstrumentsAsXLSX()`.
 319        """
 320
 321        self.iList = None  # init iList for raw instruments data
 322        """Dictionary with raw data about shares, currencies, bonds, etfs and futures from broker server. Auto-updating and saving dump to the `iListDumpFile`.
 323        
 324        See also: `Listing()`, `DumpInstruments()`.
 325        """
 326
 327        # trying to re-load raw instruments data from file `iListDumpFile` or try to update it from server:
 328        if useCache:
 329            if os.path.exists(self.iListDumpFile):
 330                dumpTime = datetime.fromtimestamp(os.path.getmtime(self.iListDumpFile)).astimezone(tzutc())  # dump modification date and time
 331                curTime = datetime.now(tzutc())
 332
 333                if (curTime.day > dumpTime.day) or (curTime.month > dumpTime.month) or (curTime.year > dumpTime.year):
 334                    uLogger.warning("Local cache may be outdated! It has last modified [{}] UTC. Updating from broker server, wait, please...".format(dumpTime.strftime(TKS_PRINT_DATE_TIME_FORMAT)))
 335
 336                    self.DumpInstruments(forceUpdate=True)  # updating self.iList and dump file
 337
 338                else:
 339                    self.iList = json.load(open(self.iListDumpFile, mode="r", encoding="UTF-8"))  # load iList from dump
 340
 341                    uLogger.debug("Local cache with raw instruments data is used: [{}]. Last modified: [{}] UTC".format(
 342                        os.path.abspath(self.iListDumpFile),
 343                        dumpTime.strftime(TKS_PRINT_DATE_TIME_FORMAT),
 344                    ))
 345
 346            else:
 347                uLogger.warning("Local cache with raw instruments data not exists! Creating new dump, wait, please...")
 348                self.DumpInstruments(forceUpdate=True)  # updating self.iList and creating default dump file
 349
 350        else:
 351            self.iList = self.Listing()  # request new raw instruments data from broker server
 352            self.DumpInstruments(forceUpdate=False)  # save raw instrument's data to default dump file `iListDumpFile`
 353
 354        self.priceModel = PriceGenerator()  # init PriceGenerator object to work with candles data
 355        """PriceGenerator object to work with candles data: load, render interact and non-interact charts and so on.
 356
 357        See also: `LoadHistory()`, `ShowHistoryChart()` and the PriceGenerator project: https://github.com/Tim55667757/PriceGenerator
 358        """
 359
 360    @property
 361    def ticker(self) -> str:
 362        """String with ticker, e.g. `GOOGL`. Tickers may be upper case only.
 363
 364        Use alias for `USD000UTSTOM` simple as `USD`, `EUR_RUB__TOM` as `EUR` etc.
 365        More tickers aliases here: `TKSEnums.TKS_TICKER_ALIASES`.
 366
 367        See also: `SearchByTicker()`, `SearchInstruments()`.
 368        """
 369        return self._ticker
 370
 371    @ticker.setter
 372    def ticker(self, value):
 373        """Setter for string with ticker, e.g. `GOOGL`. Tickers may be upper case only.
 374
 375        Use alias for `USD000UTSTOM` simple as `USD`, `EUR_RUB__TOM` as `EUR` etc.
 376        More tickers aliases here: `TKSEnums.TKS_TICKER_ALIASES`.
 377
 378        See also: `SearchByTicker()`, `SearchInstruments()`.
 379        """
 380        self._ticker = str(value).upper()  # Tickers may be upper case only
 381
 382    @property
 383    def figi(self) -> str:
 384        """String with FIGI, e.g. ticker `GOOGL` has FIGI `BBG009S39JX6`. FIGIs may be upper case only.
 385
 386        See also: `SearchByFIGI()`, `SearchInstruments()`.
 387        """
 388        return self._figi
 389
 390    @figi.setter
 391    def figi(self, value):
 392        """Setter for string with FIGI, e.g. ticker `GOOGL` has FIGI `BBG009S39JX6`. FIGIs may be upper case only.
 393
 394        See also: `SearchByFIGI()`, `SearchInstruments()`.
 395        """
 396        self._figi = str(value).upper()  # FIGI may be upper case only
 397
 398    def _ParseJSON(self, rawData="{}") -> dict:
 399        """
 400        Parse JSON from response string.
 401
 402        :param rawData: this is a string with JSON-formatted text.
 403        :return: JSON (dictionary), parsed from server response string. If an error occurred, then returns empty dict `{}`.
 404        """
 405        try:
 406            responseJSON = json.loads(rawData) if rawData else {}
 407
 408            if self.moreDebug:
 409                uLogger.debug("JSON formatted raw body data of response:\n{}".format(json.dumps(responseJSON, indent=4)))
 410
 411            return responseJSON
 412
 413        except Exception as e:
 414            uLogger.error("An empty dict will be return, because an error occurred in `_ParseJSON()` method with comment: {}".format(e))
 415
 416            return {}
 417
 418    def SendAPIRequest(self, url: str, reqType: str = "GET", retry: int = 3, pause: int = 5) -> dict:
 419        """
 420        Send GET or POST request to broker server and receive JSON object.
 421
 422        self.header: must be defining with dictionary of headers.
 423        self.body: if define then used as request body. None by default.
 424        self.timeout: global request timeout, 15 seconds by default.
 425        :param url: url with REST request.
 426        :param reqType: send "GET" or "POST" request. "GET" by default.
 427        :param retry: how many times retry after first request if an 5xx server errors occurred.
 428        :param pause: sleep time in seconds between retries.
 429        :return: response JSON (dictionary) from broker.
 430        """
 431        if reqType.upper() not in ("GET", "POST"):
 432            uLogger.error("You can define request type: `GET` or `POST`!")
 433            raise Exception("Incorrect value")
 434
 435        if self.moreDebug:
 436            uLogger.debug("Request parameters:")
 437            uLogger.debug("    - REST API URL: {}".format(url))
 438            uLogger.debug("    - request type: {}".format(reqType))
 439            uLogger.debug("    - headers:\n{}".format(str(self.headers).replace(self.token, "*** request token ***")))
 440            uLogger.debug("    - body:\n{}".format(self.body))
 441
 442        # fast hack to avoid all operations with some tickers/FIGI
 443        responseJSON = {}
 444        oK = True
 445        for item in self.exclude:
 446            if item in url:
 447                if self.moreDebug:
 448                    uLogger.warning("Do not execute operations with list of this tickers/FIGI: {}".format(str(self.exclude)))
 449
 450                oK = False
 451                break
 452
 453        if oK:
 454            with self.__lock:  # acquire the mutex lock
 455                counter = 0
 456                response = None
 457                errMsg = ""
 458
 459                while not response and counter <= retry:
 460                    if reqType == "GET":
 461                        response = requests.get(url, headers=self.headers, data=self.body, timeout=self.timeout)
 462
 463                    if reqType == "POST":
 464                        response = requests.post(url, headers=self.headers, data=self.body, timeout=self.timeout)
 465
 466                    if self.moreDebug:
 467                        uLogger.debug("Response:")
 468                        uLogger.debug("    - status code: {}".format(response.status_code))
 469                        uLogger.debug("    - reason: {}".format(response.reason))
 470                        uLogger.debug("    - body length: {}".format(len(response.text)))
 471                        uLogger.debug("    - headers:\n{}".format(response.headers))
 472
 473                    # Server returns some headers:
 474                    # - `x-ratelimit-limit` — shows the settings of the current user limit for this method.
 475                    # - `x-ratelimit-remaining` — the number of remaining requests of this type per minute.
 476                    # - `x-ratelimit-reset` — time in seconds before resetting the request counter.
 477                    # See: https://tinkoff.github.io/investAPI/grpc/#kreya
 478                    if "x-ratelimit-remaining" in response.headers.keys() and response.headers["x-ratelimit-remaining"] == "0":
 479                        rateLimitWait = int(response.headers["x-ratelimit-reset"])
 480                        uLogger.debug("Rate limit exceeded. Waiting {} sec. for reset rate limit and then repeat again...".format(rateLimitWait))
 481                        sleep(rateLimitWait)
 482
 483                    # Error status codes: https://en.wikipedia.org/wiki/List_of_HTTP_status_codes
 484                    if 400 <= response.status_code < 500:
 485                        msg = "status code: [{}], response body: {}".format(response.status_code, response.text)
 486                        uLogger.debug("    - not oK, but do not retry for 4xx errors, {}".format(msg))
 487
 488                        if "code" in response.text and "message" in response.text:
 489                            msgDict = self._ParseJSON(rawData=response.text)
 490                            uLogger.warning("HTTP-status code [{}], server message: {}".format(response.status_code, msgDict["message"]))
 491
 492                        counter = retry + 1  # do not retry for 4xx errors
 493
 494                    if 500 <= response.status_code < 600:
 495                        errMsg = "status code: [{}], response body: {}".format(response.status_code, response.text)
 496                        uLogger.debug("    - not oK, {}".format(errMsg))
 497
 498                        if "code" in response.text and "message" in response.text:
 499                            errMsgDict = self._ParseJSON(rawData=response.text)
 500                            uLogger.warning("HTTP-status code [{}], error message: {}".format(response.status_code, errMsgDict["message"]))
 501
 502                        counter += 1
 503
 504                        if counter <= retry:
 505                            uLogger.debug("Retry: [{}]. Wait {} sec. and try again...".format(counter, pause))
 506                            sleep(pause)
 507
 508                responseJSON = self._ParseJSON(rawData=response.text)
 509
 510                if errMsg:
 511                    uLogger.error("Server returns not `oK` status! See: https://tinkoff.github.io/investAPI/errors/")
 512                    uLogger.error("    - not oK, {}".format(errMsg))
 513
 514        return responseJSON
 515
 516    def _IUpdater(self, iType: str) -> tuple:
 517        """
 518        Request instrument by type from server. See available API methods for instruments:
 519        Currencies: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_Currencies
 520        Shares: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_Shares
 521        Bonds: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_Bonds
 522        Etfs: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_Etfs
 523        Futures: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_Futures
 524
 525        :param iType: type of the instrument, it must be one of supported types in TKS_INSTRUMENTS list.
 526        :return: tuple with iType name and list of available instruments of current type for defined user token.
 527        """
 528        result = []
 529
 530        if iType in TKS_INSTRUMENTS:
 531            uLogger.debug("Requesting available [{}] list. Wait, please...".format(iType))
 532
 533            # all instruments have the same body in API v2 requests:
 534            self.body = str({"instrumentStatus": "INSTRUMENT_STATUS_UNSPECIFIED"})  # Enum: [INSTRUMENT_STATUS_UNSPECIFIED, INSTRUMENT_STATUS_BASE, INSTRUMENT_STATUS_ALL]
 535            instrumentURL = self.server + r"/tinkoff.public.invest.api.contract.v1.InstrumentsService/{}".format(iType)
 536            result = self.SendAPIRequest(instrumentURL, reqType="POST")["instruments"]
 537
 538        return iType, result
 539
 540    def _IWrapper(self, kwargs):
 541        """
 542        Wrapper runs instrument's update method `_IUpdater()`.
 543        It's a workaround for using multiprocessing with kwargs. See: https://stackoverflow.com/a/36799206
 544        """
 545        return self._IUpdater(**kwargs)
 546
 547    def Listing(self) -> dict:
 548        """
 549        Gets JSON with raw data about shares, currencies, bonds, etfs and futures from broker server.
 550
 551        :return: Dictionary with all available broker instruments: currencies, shares, bonds, etfs and futures.
 552        """
 553        uLogger.debug("Requesting all available instruments for current account. Wait, please...")
 554        uLogger.debug("CPU usages for parallel requests: [{}]".format(CPU_USAGES))
 555
 556        # this parameters insert to requests: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService
 557        # iType is type of instrument, it must be one of supported types in TKS_INSTRUMENTS list.
 558        iParams = [{"iType": iType} for iType in TKS_INSTRUMENTS]
 559
 560        poolUpdater = ThreadPool(processes=CPU_USAGES)  # create pool for update instruments in parallel mode
 561        listing = poolUpdater.map(self._IWrapper, iParams)  # execute update operations
 562        poolUpdater.close()  # close the thread pool
 563        poolUpdater.join()  # wait a moment until all data returns from threads
 564
 565        # Dictionary with all broker instruments: shares, currencies, bonds, etfs and futures.
 566        # Next in this code: item[0] is "iType" and item[1] is list of available instruments from the result of _IUpdater() method
 567        iList = {item[0]: {instrument["ticker"]: instrument for instrument in item[1]} for item in listing}
 568
 569        # calculate minimum price increment (step) for all instruments and set up instrument's type:
 570        for iType in iList.keys():
 571            for ticker in iList[iType]:
 572                iList[iType][ticker]["type"] = iType
 573
 574                if "minPriceIncrement" in iList[iType][ticker].keys():
 575                    iList[iType][ticker]["step"] = NanoToFloat(
 576                        iList[iType][ticker]["minPriceIncrement"]["units"],
 577                        iList[iType][ticker]["minPriceIncrement"]["nano"],
 578                    )
 579
 580                else:
 581                    iList[iType][ticker]["step"] = 0  # hack to avoid empty value in some instruments, e.g. futures
 582
 583        return iList
 584
 585    def DumpInstrumentsAsXLSX(self, forceUpdate: bool = False) -> None:
 586        """
 587        Creates XLSX-formatted dump file with raw data of instruments to further used by data scientists or stock analytics.
 588
 589        See also: `DumpInstruments()`, `Listing()`.
 590
 591        :param forceUpdate: if `True` then at first updates data with `Listing()` method,
 592                            otherwise just saves exist `iList` as XLSX-file (default: `dump.xlsx`) .
 593        """
 594        if self.iListDumpFile is None or not self.iListDumpFile:
 595            uLogger.error("Output name of dump file must be defined!")
 596            raise Exception("Filename required")
 597
 598        if not self.iList or forceUpdate:
 599            self.iList = self.Listing()
 600
 601        xlsxDumpFile = self.iListDumpFile.replace(".json", ".xlsx") if self.iListDumpFile.endswith(".json") else self.iListDumpFile + ".xlsx"
 602
 603        # Save as XLSX with separated sheets for every type of instruments:
 604        with pd.ExcelWriter(
 605                path=xlsxDumpFile,
 606                date_format=TKS_DATE_FORMAT,
 607                datetime_format=TKS_DATE_TIME_FORMAT,
 608                mode="w",
 609        ) as writer:
 610            for iType in TKS_INSTRUMENTS:
 611                df = pd.DataFrame.from_dict(data=self.iList[iType], orient="index")  # generate pandas object from self.iList dictionary
 612                df = df[sorted(df)]  # sorted by column names
 613                df = df.applymap(
 614                    lambda item: NanoToFloat(item["units"], item["nano"]) if isinstance(item, dict) and "units" in item.keys() and "nano" in item.keys() else item,
 615                    na_action="ignore",
 616                )  # converting numbers from nano-type to float in every cell
 617                df.to_excel(
 618                    writer,
 619                    sheet_name=iType,
 620                    encoding="UTF-8",
 621                    freeze_panes=(1, 1),
 622                )  # saving as XLSX-file with freeze first row and column as headers
 623
 624        uLogger.info("XLSX-file for further used by data scientists or stock analytics: [{}]".format(os.path.abspath(xlsxDumpFile)))
 625
 626    def DumpInstruments(self, forceUpdate: bool = True) -> str:
 627        """
 628        Receives and returns actual raw data about shares, currencies, bonds, etfs and futures from broker server
 629        using `Listing()` method. If `iListDumpFile` string is not empty then also save information to this file.
 630
 631        See also: `DumpInstrumentsAsXLSX()`, `Listing()`.
 632
 633        :param forceUpdate: if `True` then at first updates data with `Listing()` method,
 634                            otherwise just saves exist `iList` as JSON-file (default: `dump.json`).
 635        :return: serialized JSON formatted `str` with full data of instruments, also saved to the `--output` JSON-file.
 636        """
 637        if self.iListDumpFile is None or not self.iListDumpFile:
 638            uLogger.error("Output name of dump file must be defined!")
 639            raise Exception("Filename required")
 640
 641        if not self.iList or forceUpdate:
 642            self.iList = self.Listing()
 643
 644        jsonDump = json.dumps(self.iList, indent=4, sort_keys=False)  # create JSON object as string
 645        with open(self.iListDumpFile, mode="w", encoding="UTF-8") as fH:
 646            fH.write(jsonDump)
 647
 648        uLogger.info("New cache of instruments data was created: [{}]".format(os.path.abspath(self.iListDumpFile)))
 649
 650        return jsonDump
 651
 652    def ShowInstrumentInfo(self, iJSON: dict, show: bool = True) -> str:
 653        """
 654        Show information about one instrument defined by json data and prints it in Markdown format.
 655
 656        See also: `SearchByTicker()`, `SearchByFIGI()`, `RequestBondCoupons()`, `ExtendBondsData()`, `ShowBondsCalendar()` and `RequestTradingStatus()`.
 657
 658        :param iJSON: json data of instrument, example: `iJSON = self.iList["Shares"][self._ticker]`
 659        :param show: if `True` then also printing information about instrument and its current price.
 660        :return: multilines text in Markdown format with information about one instrument.
 661        """
 662        splitLine = "|                                                             |                                                        |\n"
 663        infoText = ""
 664
 665        if iJSON is not None and iJSON and isinstance(iJSON, dict):
 666            info = [
 667                "# Main information\n\n",
 668                "* **Actual on date:** [{} UTC]\n\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
 669                "| Parameters                                                  | Values                                                 |\n",
 670                "|-------------------------------------------------------------|--------------------------------------------------------|\n",
 671                "| Ticker:                                                     | {:<54} |\n".format(iJSON["ticker"]),
 672                "| Full name:                                                  | {:<54} |\n".format(iJSON["name"]),
 673            ]
 674
 675            if "sector" in iJSON.keys() and iJSON["sector"]:
 676                info.append("| Sector:                                                     | {:<54} |\n".format(iJSON["sector"]))
 677
 678            if "countryOfRisk" in iJSON.keys() and iJSON["countryOfRisk"] and "countryOfRiskName" in iJSON.keys() and iJSON["countryOfRiskName"]:
 679                info.append("| Country of instrument:                                      | {:<54} |\n".format("({}) {}".format(iJSON["countryOfRisk"], iJSON["countryOfRiskName"])))
 680
 681            info.extend([
 682                splitLine,
 683                "| FIGI (Financial Instrument Global Identifier):              | {:<54} |\n".format(iJSON["figi"]),
 684                "| Real exchange [Exchange section]:                           | {:<54} |\n".format("{} [{}]".format(TKS_REAL_EXCHANGES[iJSON["realExchange"]], iJSON["exchange"])),
 685            ])
 686
 687            if "isin" in iJSON.keys() and iJSON["isin"]:
 688                info.append("| ISIN (International Securities Identification Number):      | {:<54} |\n".format(iJSON["isin"]))
 689
 690            if "classCode" in iJSON.keys():
 691                info.append("| Class Code (exchange section where instrument is traded):   | {:<54} |\n".format(iJSON["classCode"]))
 692
 693            info.extend([
 694                splitLine,
 695                "| Current broker security trading status:                     | {:<54} |\n".format(TKS_TRADING_STATUSES[iJSON["tradingStatus"]]),
 696                splitLine,
 697                "| Buy operations allowed:                                     | {:<54} |\n".format("Yes" if iJSON["buyAvailableFlag"] else "No"),
 698                "| Sale operations allowed:                                    | {:<54} |\n".format("Yes" if iJSON["sellAvailableFlag"] else "No"),
 699                "| Short positions allowed:                                    | {:<54} |\n".format("Yes" if iJSON["shortEnabledFlag"] else "No"),
 700            ])
 701
 702            if iJSON["figi"]:
 703                self._figi = iJSON["figi"]
 704                iJSON = iJSON | self.RequestTradingStatus()
 705
 706                info.extend([
 707                    splitLine,
 708                    "| Limit orders allowed:                                       | {:<54} |\n".format("Yes" if iJSON["limitOrderAvailableFlag"] else "No"),
 709                    "| Market orders allowed:                                      | {:<54} |\n".format("Yes" if iJSON["marketOrderAvailableFlag"] else "No"),
 710                    "| API trade allowed:                                          | {:<54} |\n".format("Yes" if iJSON["apiTradeAvailableFlag"] else "No"),
 711                ])
 712
 713            info.append(splitLine)
 714
 715            if "type" in iJSON.keys() and iJSON["type"]:
 716                info.append("| Type of the instrument:                                     | {:<54} |\n".format(iJSON["type"]))
 717
 718                if "shareType" in iJSON.keys() and iJSON["shareType"]:
 719                    info.append("| Share type:                                                 | {:<54} |\n".format(TKS_SHARE_TYPES[iJSON["shareType"]]))
 720
 721            if "futuresType" in iJSON.keys() and iJSON["futuresType"]:
 722                info.append("| Futures type:                                               | {:<54} |\n".format(iJSON["futuresType"]))
 723
 724            if "ipoDate" in iJSON.keys() and iJSON["ipoDate"]:
 725                info.append("| IPO date:                                                   | {:<54} |\n".format(iJSON["ipoDate"].replace("T", " ").replace("Z", "")))
 726
 727            if "releasedDate" in iJSON.keys() and iJSON["releasedDate"]:
 728                info.append("| Released date:                                              | {:<54} |\n".format(iJSON["releasedDate"].replace("T", " ").replace("Z", "")))
 729
 730            if "rebalancingFreq" in iJSON.keys() and iJSON["rebalancingFreq"]:
 731                info.append("| Rebalancing frequency:                                      | {:<54} |\n".format(iJSON["rebalancingFreq"]))
 732
 733            if "focusType" in iJSON.keys() and iJSON["focusType"]:
 734                info.append("| Focusing type:                                              | {:<54} |\n".format(iJSON["focusType"]))
 735
 736            if "assetType" in iJSON.keys() and iJSON["assetType"]:
 737                info.append("| Asset type:                                                 | {:<54} |\n".format(iJSON["assetType"]))
 738
 739            if "basicAsset" in iJSON.keys() and iJSON["basicAsset"]:
 740                info.append("| Basic asset:                                                | {:<54} |\n".format(iJSON["basicAsset"]))
 741
 742            if "basicAssetSize" in iJSON.keys() and iJSON["basicAssetSize"]:
 743                info.append("| Basic asset size:                                           | {:<54} |\n".format("{:.2f}".format(NanoToFloat(str(iJSON["basicAssetSize"]["units"]), iJSON["basicAssetSize"]["nano"]))))
 744
 745            if "isoCurrencyName" in iJSON.keys() and iJSON["isoCurrencyName"]:
 746                info.append("| ISO currency name:                                          | {:<54} |\n".format(iJSON["isoCurrencyName"]))
 747
 748            if "currency" in iJSON.keys():
 749                info.append("| Payment currency:                                           | {:<54} |\n".format(iJSON["currency"]))
 750
 751            if iJSON["type"] == "Bonds" and "nominal" in iJSON.keys() and "currency" in iJSON["nominal"].keys():
 752                info.append("| Nominal currency:                                           | {:<54} |\n".format(iJSON["nominal"]["currency"]))
 753
 754            if "firstTradeDate" in iJSON.keys() and iJSON["firstTradeDate"]:
 755                info.append("| First trade date:                                           | {:<54} |\n".format(iJSON["firstTradeDate"].replace("T", " ").replace("Z", "")))
 756
 757            if "lastTradeDate" in iJSON.keys() and iJSON["lastTradeDate"]:
 758                info.append("| Last trade date:                                            | {:<54} |\n".format(iJSON["lastTradeDate"].replace("T", " ").replace("Z", "")))
 759
 760            if "expirationDate" in iJSON.keys() and iJSON["expirationDate"]:
 761                info.append("| Date of expiration:                                         | {:<54} |\n".format(iJSON["expirationDate"].replace("T", " ").replace("Z", "")))
 762
 763            if "stateRegDate" in iJSON.keys() and iJSON["stateRegDate"]:
 764                info.append("| State registration date:                                    | {:<54} |\n".format(iJSON["stateRegDate"].replace("T", " ").replace("Z", "")))
 765
 766            if "placementDate" in iJSON.keys() and iJSON["placementDate"]:
 767                info.append("| Placement date:                                             | {:<54} |\n".format(iJSON["placementDate"].replace("T", " ").replace("Z", "")))
 768
 769            if "maturityDate" in iJSON.keys() and iJSON["maturityDate"]:
 770                info.append("| Maturity date:                                              | {:<54} |\n".format(iJSON["maturityDate"].replace("T", " ").replace("Z", "")))
 771
 772            if "perpetualFlag" in iJSON.keys() and iJSON["perpetualFlag"]:
 773                info.append("| Perpetual bond:                                             | Yes                                                    |\n")
 774
 775            if "otcFlag" in iJSON.keys() and iJSON["otcFlag"]:
 776                info.append("| Over-the-counter (OTC) securities:                          | Yes                                                    |\n")
 777
 778            iExt = None
 779            if iJSON["type"] == "Bonds":
 780                info.extend([
 781                    splitLine,
 782                    "| Bond issue (size / plan):                                   | {:<54} |\n".format("{} / {}".format(iJSON["issueSize"], iJSON["issueSizePlan"])),
 783                    "| Nominal price (100%):                                       | {:<54} |\n".format("{} {}".format(
 784                        "{:.2f}".format(NanoToFloat(str(iJSON["nominal"]["units"]), iJSON["nominal"]["nano"])).rstrip("0").rstrip("."),
 785                        iJSON["nominal"]["currency"],
 786                    )),
 787                ])
 788
 789                if "floatingCouponFlag" in iJSON.keys():
 790                    info.append("| Floating coupon:                                            | {:<54} |\n".format("Yes" if iJSON["floatingCouponFlag"] else "No"))
 791
 792                if "amortizationFlag" in iJSON.keys():
 793                    info.append("| Amortization:                                               | {:<54} |\n".format("Yes" if iJSON["amortizationFlag"] else "No"))
 794
 795                info.append(splitLine)
 796
 797                if "couponQuantityPerYear" in iJSON.keys() and iJSON["couponQuantityPerYear"]:
 798                    info.append("| Number of coupon payments per year:                         | {:<54} |\n".format(iJSON["couponQuantityPerYear"]))
 799
 800                if iJSON["figi"]:
 801                    iExt = self.ExtendBondsData(instruments=iJSON["figi"], xlsx=False)  # extended bonds data
 802
 803                    info.extend([
 804                        "| Days last to maturity date:                                 | {:<54} |\n".format(iExt["daysToMaturity"][0]),
 805                        "| Coupons yield (average coupon daily yield * 365):           | {:<54} |\n".format("{:.2f}%".format(iExt["couponsYield"][0])),
 806                        "| Current price yield (average daily yield * 365):            | {:<54} |\n".format("{:.2f}%".format(iExt["currentYield"][0])),
 807                    ])
 808
 809                if "aciValue" in iJSON.keys() and iJSON["aciValue"]:
 810                    info.append("| Current accumulated coupon income (ACI):                    | {:<54} |\n".format("{:.2f} {}".format(
 811                        NanoToFloat(str(iJSON["aciValue"]["units"]), iJSON["aciValue"]["nano"]),
 812                        iJSON["aciValue"]["currency"]
 813                    )))
 814
 815            if "currentPrice" in iJSON.keys():
 816                info.append(splitLine)
 817
 818                currency = iJSON["currency"] if "currency" in iJSON.keys() else ""  # nominal currency for bonds, otherwise currency of instrument
 819                aciCurrency = iExt["aciCurrency"][0] if iJSON["type"] == "Bonds" and iExt is not None and "aciCurrency" in iExt.keys() else ""  # payment currency
 820
 821                bondPrevClose = iExt["closePrice"][0] if iJSON["type"] == "Bonds" and iExt is not None and "closePrice" in iExt.keys() else 0  # previous close price of bond
 822                bondLastPrice = iExt["lastPrice"][0] if iJSON["type"] == "Bonds" and iExt is not None and "lastPrice" in iExt.keys() else 0  # last price of bond
 823                bondLimitUp = iExt["limitUp"][0] if iJSON["type"] == "Bonds" and iExt is not None and "limitUp" in iExt.keys() else 0  # max price of bond
 824                bondLimitDown = iExt["limitDown"][0] if iJSON["type"] == "Bonds" and iExt is not None and "limitDown" in iExt.keys() else 0  # min price of bond
 825                bondChangesDelta = iExt["changesDelta"][0] if iJSON["type"] == "Bonds" and iExt is not None and "changesDelta" in iExt.keys() else 0  # delta between last deal price and last close
 826
 827                curPriceSell = iJSON["currentPrice"]["sell"][0]["price"] if iJSON["currentPrice"]["sell"] else 0
 828                curPriceBuy = iJSON["currentPrice"]["buy"][0]["price"] if iJSON["currentPrice"]["buy"] else 0
 829
 830                info.extend([
 831                    "| Previous close price of the instrument:                     | {:<54} |\n".format("{}{}".format(
 832                        "{}".format(iJSON["currentPrice"]["closePrice"]).rstrip("0").rstrip(".") if iJSON["currentPrice"]["closePrice"] is not None else "N/A",
 833                        "% of nominal price ({:.2f} {})".format(bondPrevClose, aciCurrency) if iJSON["type"] == "Bonds" else " {}".format(currency),
 834                    )),
 835                    "| Last deal price of the instrument:                          | {:<54} |\n".format("{}{}".format(
 836                        "{}".format(iJSON["currentPrice"]["lastPrice"]).rstrip("0").rstrip(".") if iJSON["currentPrice"]["lastPrice"] is not None else "N/A",
 837                        "% of nominal price ({:.2f} {})".format(bondLastPrice, aciCurrency) if iJSON["type"] == "Bonds" else " {}".format(currency),
 838                    )),
 839                    "| Changes between last deal price and last close              | {:<54} |\n".format(
 840                        "{:.2f}%{}".format(
 841                            iJSON["currentPrice"]["changes"],
 842                            " ({}{:.2f} {})".format(
 843                                "+" if bondChangesDelta > 0 else "",
 844                                bondChangesDelta,
 845                                aciCurrency
 846                            ) if iJSON["type"] == "Bonds" else " ({}{:.2f} {})".format(
 847                                "+" if iJSON["currentPrice"]["lastPrice"] > iJSON["currentPrice"]["closePrice"] else "",
 848                                iJSON["currentPrice"]["lastPrice"] - iJSON["currentPrice"]["closePrice"],
 849                                currency
 850                            ),
 851                        )
 852                    ),
 853                    "| Current limit price, min / max:                             | {:<54} |\n".format("{}{} / {}{}{}".format(
 854                        "{}".format(iJSON["currentPrice"]["limitDown"]).rstrip("0").rstrip(".") if iJSON["currentPrice"]["limitDown"] is not None else "N/A",
 855                        "%" if iJSON["type"] == "Bonds" else " {}".format(currency),
 856                        "{}".format(iJSON["currentPrice"]["limitUp"]).rstrip("0").rstrip(".") if iJSON["currentPrice"]["limitUp"] is not None else "N/A",
 857                        "%" if iJSON["type"] == "Bonds" else " {}".format(currency),
 858                        " ({:.2f} {} / {:.2f} {})".format(bondLimitDown, aciCurrency, bondLimitUp, aciCurrency) if iJSON["type"] == "Bonds" else ""
 859                    )),
 860                    "| Actual price, sell / buy:                                   | {:<54} |\n".format("{}{} / {}{}{}".format(
 861                        "{}".format(curPriceSell).rstrip("0").rstrip(".") if curPriceSell != 0 else "N/A",
 862                        "%" if iJSON["type"] == "Bonds" else " {}".format(currency),
 863                        "{}".format(curPriceBuy).rstrip("0").rstrip(".") if curPriceBuy != 0 else "N/A",
 864                        "%" if iJSON["type"] == "Bonds" else" {}".format(currency),
 865                        " ({:.2f} {} / {:.2f} {})".format(curPriceSell, aciCurrency, curPriceBuy, aciCurrency) if iJSON["type"] == "Bonds" else ""
 866                    )),
 867                ])
 868
 869            if "lot" in iJSON.keys():
 870                info.append("| Minimum lot to buy:                                         | {:<54} |\n".format(iJSON["lot"]))
 871
 872            if "step" in iJSON.keys() and iJSON["step"] != 0:
 873                info.append("| Minimum price increment (step):                             | {:<54} |\n".format("{} {}".format(iJSON["step"], iJSON["currency"] if "currency" in iJSON.keys() else "")))
 874
 875            # Add bond payment calendar:
 876            if iJSON["type"] == "Bonds":
 877                strCalendar = self.ShowBondsCalendar(extBonds=iExt, show=False)   # bond payment calendar
 878                info.extend(["\n#", strCalendar])
 879
 880            infoText += "".join(info)
 881
 882            if show:
 883                uLogger.info("{}".format(infoText))
 884
 885            else:
 886                uLogger.debug("{}".format(infoText))
 887
 888            if self.infoFile is not None:
 889                with open(self.infoFile, "w", encoding="UTF-8") as fH:
 890                    fH.write(infoText)
 891
 892                uLogger.info("Info about instrument with ticker [{}] and FIGI [{}] was saved to file: [{}]".format(iJSON["ticker"], iJSON["figi"], os.path.abspath(self.infoFile)))
 893
 894                if self.useHTMLReports:
 895                    htmlFilePath = self.infoFile.replace(".md", ".html") if self.infoFile.endswith(".md") else self.infoFile + ".html"
 896                    with open(htmlFilePath, "w", encoding="UTF-8") as fH:
 897                        fH.write(Template(text=MAIN_INFO_TEMPLATE).render(mainTitle="Main information", commonCSS=COMMON_CSS, markdown=infoText))
 898
 899                    uLogger.info("The report has also been converted to an HTML file: [{}]".format(os.path.abspath(htmlFilePath)))
 900
 901        return infoText
 902
 903    def SearchByTicker(self, requestPrice: bool = False, show: bool = False) -> dict:
 904        """
 905        Search and return raw broker's information about instrument by its ticker. Variable `ticker` must be defined!
 906
 907        :param requestPrice: if `False` then do not request current price of instrument (because this is long operation).
 908        :param show: if `False` then do not run `ShowInstrumentInfo()` method and do not print info to the console.
 909        :return: JSON formatted data with information about instrument.
 910        """
 911        tickerJSON = {}
 912        if self.moreDebug:
 913            uLogger.debug("Searching information about instrument by it's ticker [{}] ...".format(self._ticker))
 914
 915        if not self._ticker:
 916            uLogger.warning("self._ticker variable is not be empty!")
 917
 918        else:
 919            if self._ticker in TKS_TICKERS_OR_FIGI_EXCLUDED:
 920                uLogger.warning("Instrument with ticker [{}] not allowed for trading!".format(self._ticker))
 921                raise Exception("Instrument not allowed")
 922
 923            if not self.iList:
 924                self.iList = self.Listing()
 925
 926            if self._ticker in self.iList["Shares"].keys():
 927                tickerJSON = self.iList["Shares"][self._ticker]
 928                if self.moreDebug:
 929                    uLogger.debug("Ticker [{}] found in shares list".format(self._ticker))
 930
 931            elif self._ticker in self.iList["Currencies"].keys():
 932                tickerJSON = self.iList["Currencies"][self._ticker]
 933                if self.moreDebug:
 934                    uLogger.debug("Ticker [{}] found in currencies list".format(self._ticker))
 935
 936            elif self._ticker in self.iList["Bonds"].keys():
 937                tickerJSON = self.iList["Bonds"][self._ticker]
 938                if self.moreDebug:
 939                    uLogger.debug("Ticker [{}] found in bonds list".format(self._ticker))
 940
 941            elif self._ticker in self.iList["Etfs"].keys():
 942                tickerJSON = self.iList["Etfs"][self._ticker]
 943                if self.moreDebug:
 944                    uLogger.debug("Ticker [{}] found in etfs list".format(self._ticker))
 945
 946            elif self._ticker in self.iList["Futures"].keys():
 947                tickerJSON = self.iList["Futures"][self._ticker]
 948                if self.moreDebug:
 949                    uLogger.debug("Ticker [{}] found in futures list".format(self._ticker))
 950
 951        if tickerJSON:
 952            self._figi = tickerJSON["figi"]
 953
 954            if requestPrice:
 955                tickerJSON["currentPrice"] = self.GetCurrentPrices(show=False)
 956
 957                if tickerJSON["currentPrice"]["closePrice"] is not None and tickerJSON["currentPrice"]["closePrice"] != 0 and tickerJSON["currentPrice"]["lastPrice"] is not None:
 958                    tickerJSON["currentPrice"]["changes"] = 100 * (tickerJSON["currentPrice"]["lastPrice"] - tickerJSON["currentPrice"]["closePrice"]) / tickerJSON["currentPrice"]["closePrice"]
 959
 960                else:
 961                    tickerJSON["currentPrice"]["changes"] = 0
 962
 963            if show:
 964                self.ShowInstrumentInfo(iJSON=tickerJSON, show=True)  # print info as Markdown text
 965
 966        else:
 967            if show:
 968                uLogger.warning("Ticker [{}] not found in available broker instrument's list!".format(self._ticker))
 969
 970        return tickerJSON
 971
 972    def SearchByFIGI(self, requestPrice: bool = False, show: bool = False) -> dict:
 973        """
 974        Search and return raw broker's information about instrument by its FIGI. Variable `figi` must be defined!
 975
 976        :param requestPrice: if `False` then do not request current price of instrument (it's long operation).
 977        :param show: if `False` then do not run `ShowInstrumentInfo()` method and do not print info to the console.
 978        :return: JSON formatted data with information about instrument.
 979        """
 980        figiJSON = {}
 981        if self.moreDebug:
 982            uLogger.debug("Searching information about instrument by it's FIGI [{}] ...".format(self._figi))
 983
 984        if not self._figi:
 985            uLogger.warning("self._figi variable is not be empty!")
 986
 987        else:
 988            if self._figi in TKS_TICKERS_OR_FIGI_EXCLUDED:
 989                uLogger.warning("Instrument with figi [{}] not allowed for trading!".format(self._figi))
 990                raise Exception("Instrument not allowed")
 991
 992            if not self.iList:
 993                self.iList = self.Listing()
 994
 995            for item in self.iList["Shares"].keys():
 996                if self._figi == self.iList["Shares"][item]["figi"]:
 997                    figiJSON = self.iList["Shares"][item]
 998
 999                    if self.moreDebug:
1000                        uLogger.debug("FIGI [{}] found in shares list".format(self._figi))
1001
1002                    break
1003
1004            if not figiJSON:
1005                for item in self.iList["Currencies"].keys():
1006                    if self._figi == self.iList["Currencies"][item]["figi"]:
1007                        figiJSON = self.iList["Currencies"][item]
1008
1009                        if self.moreDebug:
1010                            uLogger.debug("FIGI [{}] found in currencies list".format(self._figi))
1011
1012                        break
1013
1014            if not figiJSON:
1015                for item in self.iList["Bonds"].keys():
1016                    if self._figi == self.iList["Bonds"][item]["figi"]:
1017                        figiJSON = self.iList["Bonds"][item]
1018
1019                        if self.moreDebug:
1020                            uLogger.debug("FIGI [{}] found in bonds list".format(self._figi))
1021
1022                        break
1023
1024            if not figiJSON:
1025                for item in self.iList["Etfs"].keys():
1026                    if self._figi == self.iList["Etfs"][item]["figi"]:
1027                        figiJSON = self.iList["Etfs"][item]
1028
1029                        if self.moreDebug:
1030                            uLogger.debug("FIGI [{}] found in etfs list".format(self._figi))
1031
1032                        break
1033
1034            if not figiJSON:
1035                for item in self.iList["Futures"].keys():
1036                    if self._figi == self.iList["Futures"][item]["figi"]:
1037                        figiJSON = self.iList["Futures"][item]
1038
1039                        if self.moreDebug:
1040                            uLogger.debug("FIGI [{}] found in futures list".format(self._figi))
1041
1042                        break
1043
1044        if figiJSON:
1045            self._figi = figiJSON["figi"]
1046            self._ticker = figiJSON["ticker"]
1047
1048            if requestPrice:
1049                figiJSON["currentPrice"] = self.GetCurrentPrices(show=False)
1050
1051                if figiJSON["currentPrice"]["closePrice"] is not None and figiJSON["currentPrice"]["closePrice"] != 0 and figiJSON["currentPrice"]["lastPrice"] is not None:
1052                    figiJSON["currentPrice"]["changes"] = 100 * (figiJSON["currentPrice"]["lastPrice"] - figiJSON["currentPrice"]["closePrice"]) / figiJSON["currentPrice"]["closePrice"]
1053
1054                else:
1055                    figiJSON["currentPrice"]["changes"] = 0
1056
1057            if show:
1058                self.ShowInstrumentInfo(iJSON=figiJSON, show=True)  # print info as Markdown text
1059
1060        else:
1061            if show:
1062                uLogger.warning("FIGI [{}] not found in available broker instrument's list!".format(self._figi))
1063
1064        return figiJSON
1065
1066    def GetCurrentPrices(self, show: bool = True) -> dict:
1067        """
1068        Get and show Depth of Market with current prices of the instrument as dictionary. Result example with `depth` 5:
1069        `{"buy": [{"price": 1243.8, "quantity": 193},
1070                  {"price": 1244.0, "quantity": 168},
1071                  {"price": 1244.8, "quantity": 5},
1072                  {"price": 1245.0, "quantity": 61},
1073                  {"price": 1245.4, "quantity": 60}],
1074          "sell": [{"price": 1243.6, "quantity": 8},
1075                   {"price": 1242.6, "quantity": 10},
1076                   {"price": 1242.4, "quantity": 18},
1077                   {"price": 1242.2, "quantity": 50},
1078                   {"price": 1242.0, "quantity": 113}],
1079          "limitUp": 1619.0, "limitDown": 903.4, "lastPrice": 1243.8, "closePrice": 1263.0}`, where parameters mean:
1080        - buy: list of dicts with Sellers prices, see also: https://tinkoff.github.io/investAPI/marketdata/#order
1081        - sell: list of dicts with Buyers prices,
1082            - price: price of 1 instrument (to get the cost of the lot, you need to multiply it by the lot of size of the instrument),
1083            - quantity: volume value by current price in lots,
1084        - limitUp: current trade session limit price, maximum,
1085        - limitDown: current trade session limit price, minimum,
1086        - lastPrice: last deal price of the instrument,
1087        - closePrice: previous trade session close price of the instrument.
1088
1089        See also: `SearchByTicker()` and `SearchByFIGI()`.
1090        REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/MarketDataService/MarketDataService_GetOrderBook
1091        Response fields: https://tinkoff.github.io/investAPI/marketdata/#getorderbookresponse
1092
1093        :param show: if `True` then print DOM to log and console.
1094        :return: orders book dict with lists of current buy and sell prices: `{"buy": [{"price": x1, "quantity": y1, ...}], "sell": [....]}`.
1095                 If an error occurred then returns an empty record:
1096                 `{"buy": [], "sell": [], "limitUp": None, "limitDown": None, "lastPrice": None, "closePrice": None}`.
1097        """
1098        prices = {"buy": [], "sell": [], "limitUp": 0, "limitDown": 0, "lastPrice": 0, "closePrice": 0}
1099
1100        if self.depth < 1:
1101            uLogger.error("Depth of Market (DOM) must be >=1!")
1102            raise Exception("Incorrect value")
1103
1104        if not (self._ticker or self._figi):
1105            uLogger.error("self._ticker or self._figi variables must be defined!")
1106            raise Exception("Ticker or FIGI required")
1107
1108        if self._ticker and not self._figi:
1109            instrumentByTicker = self.SearchByTicker(requestPrice=False)  # WARNING! requestPrice=False to avoid recursion!
1110            self._figi = instrumentByTicker["figi"] if instrumentByTicker else ""
1111
1112        if not self._ticker and self._figi:
1113            instrumentByFigi = self.SearchByFIGI(requestPrice=False)  # WARNING! requestPrice=False to avoid recursion!
1114            self._ticker = instrumentByFigi["ticker"] if instrumentByFigi else ""
1115
1116        if not self._figi:
1117            uLogger.error("FIGI is not defined!")
1118            raise Exception("Ticker or FIGI required")
1119
1120        else:
1121            uLogger.debug("Requesting current prices: ticker [{}], FIGI [{}]. Wait, please...".format(self._ticker, self._figi))
1122
1123            # REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/MarketDataService/MarketDataService_GetOrderBook
1124            priceURL = self.server + r"/tinkoff.public.invest.api.contract.v1.MarketDataService/GetOrderBook"
1125            self.body = str({"figi": self._figi, "depth": self.depth})
1126            pricesResponse = self.SendAPIRequest(priceURL, reqType="POST")  # Response fields: https://tinkoff.github.io/investAPI/marketdata/#getorderbookresponse
1127
1128            if pricesResponse and not ("code" in pricesResponse.keys() or "message" in pricesResponse.keys() or "description" in pricesResponse.keys()):
1129                # list of dicts with sellers orders:
1130                prices["buy"] = [{"price": round(NanoToFloat(item["price"]["units"], item["price"]["nano"]), 6), "quantity": int(item["quantity"])} for item in pricesResponse["asks"]]
1131
1132                # list of dicts with buyers orders:
1133                prices["sell"] = [{"price": round(NanoToFloat(item["price"]["units"], item["price"]["nano"]), 6), "quantity": int(item["quantity"])} for item in pricesResponse["bids"]]
1134
1135                # max price of instrument at this time:
1136                prices["limitUp"] = round(NanoToFloat(pricesResponse["limitUp"]["units"], pricesResponse["limitUp"]["nano"]), 6) if "limitUp" in pricesResponse.keys() else None
1137
1138                # min price of instrument at this time:
1139                prices["limitDown"] = round(NanoToFloat(pricesResponse["limitDown"]["units"], pricesResponse["limitDown"]["nano"]), 6) if "limitDown" in pricesResponse.keys() else None
1140
1141                # last price of deal with instrument:
1142                prices["lastPrice"] = round(NanoToFloat(pricesResponse["lastPrice"]["units"], pricesResponse["lastPrice"]["nano"]), 6) if "lastPrice" in pricesResponse.keys() else 0
1143
1144                # last close price of instrument:
1145                prices["closePrice"] = round(NanoToFloat(pricesResponse["closePrice"]["units"], pricesResponse["closePrice"]["nano"]), 6) if "closePrice" in pricesResponse.keys() else 0
1146
1147            else:
1148                uLogger.warning("Server return an empty or error response! See full log. Instrument: ticker [{}], FIGI [{}]".format(self._ticker, self._figi))
1149                uLogger.debug("Server response: {}".format(pricesResponse))
1150
1151            if show:
1152                if prices["buy"] or prices["sell"]:
1153                    info = [
1154                        "Orders book actual at [{}] (UTC)\nTicker: [{}], FIGI: [{}], Depth of Market: [{}]\n".format(
1155                            datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT),
1156                            self._ticker,
1157                            self._figi,
1158                            self.depth,
1159                        ),
1160                        "-" * 60, "\n",
1161                        "             Orders of Buyers | Orders of Sellers\n",
1162                        "-" * 60, "\n",
1163                        "        Sell prices (volumes) | Buy prices (volumes)\n",
1164                        "-" * 60, "\n",
1165                    ]
1166
1167                    if not prices["buy"]:
1168                        info.append("                              | No orders!\n")
1169                        sumBuy = 0
1170
1171                    else:
1172                        sumBuy = sum([x["quantity"] for x in prices["buy"]])
1173                        maxMinSorted = sorted(prices["buy"], key=lambda k: k["price"], reverse=True)
1174                        for item in maxMinSorted:
1175                            info.append("                              | {} ({})\n".format(item["price"], item["quantity"]))
1176
1177                    if not prices["sell"]:
1178                        info.append("No orders!                    |\n")
1179                        sumSell = 0
1180
1181                    else:
1182                        sumSell = sum([x["quantity"] for x in prices["sell"]])
1183                        for item in prices["sell"]:
1184                            info.append("{:>29} |\n".format("{} ({})".format(item["price"], item["quantity"])))
1185
1186                    info.extend([
1187                        "-" * 60, "\n",
1188                        "{:>29} | {}\n".format("Total sell: {}".format(sumSell), "Total buy: {}".format(sumBuy)),
1189                        "-" * 60, "\n",
1190                    ])
1191
1192                    infoText = "".join(info)
1193
1194                    uLogger.info("Current prices in order book:\n\n{}".format(infoText))
1195
1196                else:
1197                    uLogger.warning("Orders book is empty at this time! Instrument: ticker [{}], FIGI [{}]".format(self._ticker, self._figi))
1198
1199        return prices
1200
1201    def ShowInstrumentsInfo(self, show: bool = True) -> str:
1202        """
1203        This method get and show information about all available broker instruments for current user account.
1204        If `instrumentsFile` string is not empty then also save information to this file.
1205
1206        :param show: if `True` then print results to console, if `False` — print only to file.
1207        :return: multi-lines string with all available broker instruments
1208        """
1209        if not self.iList:
1210            self.iList = self.Listing()
1211
1212        info = [
1213            "# All available instruments from Tinkoff Broker server for current user token\n\n",
1214            "* **Actual on date:** [{} UTC]\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
1215        ]
1216
1217        # add instruments count by type:
1218        for iType in self.iList.keys():
1219            info.append("* **{}:** [{}]\n".format(iType, len(self.iList[iType])))
1220
1221        headerLine = "| Ticker       | Full name                                                 | FIGI         | Cur | Lot     | Step       |\n"
1222        splitLine = "|--------------|-----------------------------------------------------------|--------------|-----|---------|------------|\n"
1223
1224        # generating info tables with all instruments by type:
1225        for iType in self.iList.keys():
1226            info.extend(["\n\n## {} available. Total: [{}]\n\n".format(iType, len(self.iList[iType])), headerLine, splitLine])
1227
1228            for instrument in self.iList[iType].keys():
1229                iName = self.iList[iType][instrument]["name"]  # instrument's name
1230                if len(iName) > 57:
1231                    iName = "{}...".format(iName[:54])  # right trim for a long string
1232
1233                info.append("| {:<12} | {:<57} | {:<12} | {:<3} | {:<7} | {:<10} |\n".format(
1234                    self.iList[iType][instrument]["ticker"],
1235                    iName,
1236                    self.iList[iType][instrument]["figi"],
1237                    self.iList[iType][instrument]["currency"],
1238                    self.iList[iType][instrument]["lot"],
1239                    "{:.10f}".format(self.iList[iType][instrument]["step"]).rstrip("0").rstrip(".") if self.iList[iType][instrument]["step"] > 0 else 0,
1240                ))
1241
1242        infoText = "".join(info)
1243
1244        if show:
1245            uLogger.info(infoText)
1246
1247        if self.instrumentsFile:
1248            with open(self.instrumentsFile, "w", encoding="UTF-8") as fH:
1249                fH.write(infoText)
1250
1251            uLogger.info("All available instruments are saved to file: [{}]".format(os.path.abspath(self.instrumentsFile)))
1252
1253            if self.useHTMLReports:
1254                htmlFilePath = self.instrumentsFile.replace(".md", ".html") if self.instrumentsFile.endswith(".md") else self.instrumentsFile + ".html"
1255                with open(htmlFilePath, "w", encoding="UTF-8") as fH:
1256                    fH.write(Template(text=MAIN_INFO_TEMPLATE).render(mainTitle="List of instruments", commonCSS=COMMON_CSS, markdown=infoText))
1257
1258                uLogger.info("The report has also been converted to an HTML file: [{}]".format(os.path.abspath(htmlFilePath)))
1259
1260        return infoText
1261
1262    def SearchInstruments(self, pattern: str, show: bool = True) -> dict:
1263        """
1264        This method search and show information about instruments by part of its ticker, FIGI or name.
1265        If `searchResultsFile` string is not empty then also save information to this file.
1266
1267        :param pattern: string with part of ticker, FIGI or instrument's name.
1268        :param show: if `True` then print results to console, if `False` — return list of result only.
1269        :return: list of dictionaries with all found instruments.
1270        """
1271        if not self.iList:
1272            self.iList = self.Listing()
1273
1274        searchResults = {iType: {} for iType in self.iList}  # same as iList but will contain only filtered instruments
1275        compiledPattern = re.compile(pattern, re.IGNORECASE)
1276
1277        for iType in self.iList:
1278            for instrument in self.iList[iType].values():
1279                searchResult = compiledPattern.search(" ".join(
1280                    [instrument["ticker"], instrument["figi"], instrument["name"]]
1281                ))
1282
1283                if searchResult:
1284                    searchResults[iType][instrument["ticker"]] = instrument
1285
1286        resultsLen = sum([len(searchResults[iType]) for iType in searchResults])
1287        info = [
1288            "# Search results\n\n",
1289            "* **Actual on date:** [{} UTC]\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
1290            "* **Search pattern:** [{}]\n".format(pattern),
1291            "* **Found instruments:** [{}]\n\n".format(resultsLen),
1292            '**Note:** you can view info about found instruments with key "--info", e.g.: "tksbrokerapi -t TICKER --info" or "tksbrokerapi -f FIGI --info".\n'
1293        ]
1294        infoShort = info[:]
1295
1296        headerLine = "| Type       | Ticker       | Full name                                                      | FIGI         |\n"
1297        splitLine = "|------------|--------------|----------------------------------------------------------------|--------------|\n"
1298        skippedLine = "| ...        | ...          | ...                                                            | ...          |\n"
1299
1300        if resultsLen == 0:
1301            info.append("\nNo results\n")
1302            infoShort.append("\nNo results\n")
1303            uLogger.warning("No results. Try changing your search pattern.")
1304
1305        else:
1306            for iType in searchResults:
1307                iTypeValuesCount = len(searchResults[iType].values())
1308                if iTypeValuesCount > 0:
1309                    info.extend(["\n## {}: [{}]\n\n".format(iType, iTypeValuesCount), headerLine, splitLine])
1310                    infoShort.extend(["\n### {}: [{}]\n\n".format(iType, iTypeValuesCount), headerLine, splitLine])
1311
1312                    for instrument in searchResults[iType].values():
1313                        info.append("| {:<10} | {:<12} | {:<63}| {:<13}|\n".format(
1314                            instrument["type"],
1315                            instrument["ticker"],
1316                            "{}...".format(instrument["name"][:60]) if len(instrument["name"]) > 63 else instrument["name"],  # right trim for a long string
1317                            instrument["figi"],
1318                        ))
1319
1320                    if iTypeValuesCount <= 5:
1321                        infoShort.extend(info[-iTypeValuesCount:])
1322
1323                    else:
1324                        infoShort.extend(info[-5:])
1325                        infoShort.append(skippedLine)
1326
1327        infoText = "".join(info)
1328        infoTextShort = "".join(infoShort)
1329
1330        if show:
1331            uLogger.info(infoTextShort)
1332            uLogger.info("You can view info about found instruments with key `--info`, e.g.: `tksbrokerapi -t IBM --info` or `tksbrokerapi -f BBG000BLNNH6 --info`")
1333
1334        if self.searchResultsFile:
1335            with open(self.searchResultsFile, "w", encoding="UTF-8") as fH:
1336                fH.write(infoText)
1337
1338            uLogger.info("Full search results were saved to file: [{}]".format(os.path.abspath(self.searchResultsFile)))
1339
1340            if self.useHTMLReports:
1341                htmlFilePath = self.searchResultsFile.replace(".md", ".html") if self.searchResultsFile.endswith(".md") else self.searchResultsFile + ".html"
1342                with open(htmlFilePath, "w", encoding="UTF-8") as fH:
1343                    fH.write(Template(text=MAIN_INFO_TEMPLATE).render(mainTitle="Search results", commonCSS=COMMON_CSS, markdown=infoText))
1344
1345                uLogger.info("The report has also been converted to an HTML file: [{}]".format(os.path.abspath(htmlFilePath)))
1346
1347        return searchResults
1348
1349    def GetUniqueFIGIs(self, instruments: list[str]) -> list:
1350        """
1351        Creating list with unique instrument FIGIs from input list of tickers (priority) or FIGIs.
1352
1353        :param instruments: list of strings with tickers or FIGIs.
1354        :return: list with unique instrument FIGIs only.
1355        """
1356        requestedInstruments = []
1357        for iName in instruments:
1358            if iName not in self.aliases.keys():
1359                if iName not in requestedInstruments:
1360                    requestedInstruments.append(iName)
1361
1362            else:
1363                if iName not in requestedInstruments:
1364                    if self.aliases[iName] not in requestedInstruments:
1365                        requestedInstruments.append(self.aliases[iName])
1366
1367        uLogger.debug("Requested instruments without duplicates of tickers or FIGIs: {}".format(requestedInstruments))
1368
1369        onlyUniqueFIGIs = []
1370        for iName in requestedInstruments:
1371            if iName in TKS_TICKERS_OR_FIGI_EXCLUDED:
1372                continue
1373
1374            self._ticker = iName
1375            iData = self.SearchByTicker(requestPrice=False)  # trying to find instrument by ticker
1376
1377            if not iData:
1378                self._ticker = ""
1379                self._figi = iName
1380
1381                iData = self.SearchByFIGI(requestPrice=False)  # trying to find instrument by FIGI
1382
1383                if not iData:
1384                    self._figi = ""
1385                    uLogger.warning("Instrument [{}] not in list of available instruments for current token!".format(iName))
1386
1387            if iData and iData["figi"] not in onlyUniqueFIGIs:
1388                onlyUniqueFIGIs.append(iData["figi"])
1389
1390        uLogger.debug("Unique list of FIGIs: {}".format(onlyUniqueFIGIs))
1391
1392        return onlyUniqueFIGIs
1393
1394    def GetListOfPrices(self, instruments: list[str], show: bool = False) -> list[dict]:
1395        """
1396        This method get, maybe show and return prices of list of instruments. WARNING! This is potential long operation!
1397
1398        See limits: https://tinkoff.github.io/investAPI/limits/
1399
1400        If `pricesFile` string is not empty then also save information to this file.
1401
1402        :param instruments: list of strings with tickers or FIGIs.
1403        :param show: if `True` then prints prices to console, if `False` — prints only to file `pricesFile`.
1404        :return: list of instruments looks like `[{some ticker info, "currentPrice": {current prices}}, {...}, ...]`.
1405                 One item is dict returned by `SearchByTicker()` or `SearchByFIGI()` methods.
1406        """
1407        if instruments is None or not instruments:
1408            uLogger.error("You must define some of tickers or FIGIs to request it's actual prices!")
1409            raise Exception("Ticker or FIGI required")
1410
1411        onlyUniqueFIGIs = self.GetUniqueFIGIs(instruments)
1412
1413        uLogger.debug("Requesting current prices from Tinkoff Broker server...")
1414
1415        iList = []  # trying to get info and current prices about all unique instruments:
1416        for self._figi in onlyUniqueFIGIs:
1417            iData = self.SearchByFIGI(requestPrice=True)
1418            iList.append(iData)
1419
1420        self.ShowListOfPrices(iList, show)
1421
1422        return iList
1423
1424    def ShowListOfPrices(self, iList: list, show: bool = True) -> str:
1425        """
1426        Show table contains current prices of given instruments.
1427
1428        :param iList: list of instruments looks like `[{some ticker info, "currentPrice": {current prices}}, {...}, ...]`.
1429                      One item is dict returned by `SearchByTicker(requestPrice=True)` or by `SearchByFIGI(requestPrice=True)` methods.
1430        :param show: if `True` then prints prices to console, if `False` — prints only to file `pricesFile`.
1431        :return: multilines text in Markdown format as a table contains current prices.
1432        """
1433        infoText = ""
1434
1435        if show or self.pricesFile:
1436            info = [
1437                "# Current prices\n\n* **Actual on date:** [{} UTC]\n\n".format(datetime.now(tzutc()).strftime("%Y-%m-%d %H:%M")),
1438                "| Ticker       | FIGI         | Type       | Prev. close | Last price  | Chg. %   | Day limits min/max  | Actual sell / buy   | Curr. |\n",
1439                "|--------------|--------------|------------|-------------|-------------|----------|---------------------|---------------------|-------|\n",
1440            ]
1441
1442            for item in iList:
1443                info.append("| {:<12} | {:<12} | {:<10} | {:>11} | {:>11} | {:>7}% | {:>19} | {:>19} | {:<5} |\n".format(
1444                    item["ticker"],
1445                    item["figi"],
1446                    item["type"],
1447                    "{:.2f}".format(float(item["currentPrice"]["closePrice"])),
1448                    "{:.2f}".format(float(item["currentPrice"]["lastPrice"])),
1449                    "{}{:.2f}".format("+" if item["currentPrice"]["changes"] > 0 else "", float(item["currentPrice"]["changes"])),
1450                    "{} / {}".format(
1451                        item["currentPrice"]["limitDown"] if item["currentPrice"]["limitDown"] is not None else "N/A",
1452                        item["currentPrice"]["limitUp"] if item["currentPrice"]["limitUp"] is not None else "N/A",
1453                    ),
1454                    "{} / {}".format(
1455                        item["currentPrice"]["sell"][0]["price"] if item["currentPrice"]["sell"] else "N/A",
1456                        item["currentPrice"]["buy"][0]["price"] if item["currentPrice"]["buy"] else "N/A",
1457                    ),
1458                    item["currency"],
1459                ))
1460
1461            infoText = "".join(info)
1462
1463            if show:
1464                uLogger.info("Only instruments with unique FIGIs are shown:\n{}".format(infoText))
1465
1466            if self.pricesFile:
1467                with open(self.pricesFile, "w", encoding="UTF-8") as fH:
1468                    fH.write(infoText)
1469
1470                uLogger.info("Price list for all instruments saved to file: [{}]".format(os.path.abspath(self.pricesFile)))
1471
1472                if self.useHTMLReports:
1473                    htmlFilePath = self.pricesFile.replace(".md", ".html") if self.pricesFile.endswith(".md") else self.pricesFile + ".html"
1474                    with open(htmlFilePath, "w", encoding="UTF-8") as fH:
1475                        fH.write(Template(text=MAIN_INFO_TEMPLATE).render(mainTitle="Current prices", commonCSS=COMMON_CSS, markdown=infoText))
1476
1477                    uLogger.info("The report has also been converted to an HTML file: [{}]".format(os.path.abspath(htmlFilePath)))
1478
1479        return infoText
1480
1481    def RequestTradingStatus(self) -> dict:
1482        """
1483        Requesting trading status for the instrument defined by `figi` variable.
1484
1485        REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/MarketDataService/MarketDataService_GetTradingStatus
1486
1487        Documentation: https://tinkoff.github.io/investAPI/marketdata/#gettradingstatusrequest
1488
1489        :return: dictionary with trading status attributes. Response example:
1490                 `{"figi": "TCS00A103X66", "tradingStatus": "SECURITY_TRADING_STATUS_NOT_AVAILABLE_FOR_TRADING",
1491                  "limitOrderAvailableFlag": false, "marketOrderAvailableFlag": false, "apiTradeAvailableFlag": true}`
1492        """
1493        if self._figi is None or not self._figi:
1494            uLogger.error("Variable `figi` must be defined for using this method!")
1495            raise Exception("FIGI required")
1496
1497        uLogger.debug("Requesting current trading status, FIGI: [{}]. Wait, please...".format(self._figi))
1498
1499        self.body = str({"figi": self._figi, "instrumentId": self._figi})
1500        tradingStatusURL = self.server + r"/tinkoff.public.invest.api.contract.v1.MarketDataService/GetTradingStatus"
1501        tradingStatus = self.SendAPIRequest(tradingStatusURL, reqType="POST")
1502
1503        if self.moreDebug:
1504            uLogger.debug("Records about current trading status successfully received")
1505
1506        return tradingStatus
1507
1508    def RequestPortfolio(self) -> dict:
1509        """
1510        Requesting actual user's portfolio for current `accountId`.
1511
1512        REST API for user portfolio: https://tinkoff.github.io/investAPI/swagger-ui/#/OperationsService/OperationsService_GetPortfolio
1513
1514        Documentation: https://tinkoff.github.io/investAPI/operations/#portfoliorequest
1515
1516        :return: dictionary with user's portfolio.
1517        """
1518        if self.accountId is None or not self.accountId:
1519            uLogger.error("Variable `accountId` must be defined for using this method!")
1520            raise Exception("Account ID required")
1521
1522        uLogger.debug("Requesting current actual user's portfolio. Wait, please...")
1523
1524        self.body = str({"accountId": self.accountId})
1525        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OperationsService/GetPortfolio"
1526        rawPortfolio = self.SendAPIRequest(portfolioURL, reqType="POST")
1527
1528        if self.moreDebug:
1529            uLogger.debug("Records about user's portfolio successfully received")
1530
1531        return rawPortfolio
1532
1533    def RequestPositions(self) -> dict:
1534        """
1535        Requesting open positions by currencies and instruments for current `accountId`.
1536
1537        REST API for open positions: https://tinkoff.github.io/investAPI/swagger-ui/#/OperationsService/OperationsService_GetPositions
1538
1539        Documentation: https://tinkoff.github.io/investAPI/operations/#positionsrequest
1540
1541        :return: dictionary with open positions by instruments.
1542        """
1543        if self.accountId is None or not self.accountId:
1544            uLogger.error("Variable `accountId` must be defined for using this method!")
1545            raise Exception("Account ID required")
1546
1547        uLogger.debug("Requesting current open positions in currencies and instruments. Wait, please...")
1548
1549        self.body = str({"accountId": self.accountId})
1550        positionsURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OperationsService/GetPositions"
1551        rawPositions = self.SendAPIRequest(positionsURL, reqType="POST")
1552
1553        if self.moreDebug:
1554            uLogger.debug("Records about current open positions successfully received")
1555
1556        return rawPositions
1557
1558    def RequestPendingOrders(self) -> list:
1559        """
1560        Requesting current actual pending limit orders for current `accountId`.
1561
1562        REST API for pending (market) orders: https://tinkoff.github.io/investAPI/swagger-ui/#/OrdersService/OrdersService_GetOrders
1563
1564        Documentation: https://tinkoff.github.io/investAPI/orders/#getordersrequest
1565
1566        :return: list of dictionaries with pending limit orders.
1567        """
1568        if self.accountId is None or not self.accountId:
1569            uLogger.error("Variable `accountId` must be defined for using this method!")
1570            raise Exception("Account ID required")
1571
1572        uLogger.debug("Requesting current actual pending limit orders. Wait, please...")
1573
1574        self.body = str({"accountId": self.accountId})
1575        ordersURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OrdersService/GetOrders"
1576        rawResponse = self.SendAPIRequest(ordersURL, reqType="POST")
1577
1578        if "orders" in rawResponse.keys():
1579            rawOrders = rawResponse["orders"]
1580            uLogger.debug("[{}] records about pending limit orders received".format(len(rawOrders)))
1581
1582        else:
1583            rawOrders = []
1584            uLogger.debug("No pending limit orders returned! rawResponse = {}".format(rawResponse))
1585
1586        return rawOrders
1587
1588    def RequestStopOrders(self) -> list:
1589        """
1590        Requesting current actual stop orders for current `accountId`.
1591
1592        REST API for opened stop-orders: https://tinkoff.github.io/investAPI/swagger-ui/#/StopOrdersService/StopOrdersService_GetStopOrders
1593
1594        Documentation: https://tinkoff.github.io/investAPI/stoporders/#getstopordersrequest
1595
1596        :return: list of dictionaries with stop orders.
1597        """
1598        if self.accountId is None or not self.accountId:
1599            uLogger.error("Variable `accountId` must be defined for using this method!")
1600            raise Exception("Account ID required")
1601
1602        uLogger.debug("Requesting current actual stop orders. Wait, please...")
1603
1604        self.body = str({"accountId": self.accountId})
1605        stopOrdersURL = self.server + r"/tinkoff.public.invest.api.contract.v1.StopOrdersService/GetStopOrders"
1606        rawResponse = self.SendAPIRequest(stopOrdersURL, reqType="POST")
1607
1608        if "stopOrders" in rawResponse.keys():
1609            rawStopOrders = rawResponse["stopOrders"]
1610            uLogger.debug("[{}] records about stop orders received".format(len(rawStopOrders)))
1611
1612        else:
1613            rawStopOrders = []
1614            uLogger.debug("No stop orders returned! rawResponse = {}".format(rawResponse))
1615
1616        return rawStopOrders
1617
1618    def Overview(self, show: bool = False, details: str = "full") -> dict:
1619        """
1620        Get portfolio: all open positions, orders and some statistics for current `accountId`.
1621        If `overviewFile`, `overviewDigestFile`, `overviewPositionsFile`, `overviewOrdersFile`, `overviewAnalyticsFile`
1622        and `overviewBondsCalendarFile` are defined then also save information to file.
1623
1624        WARNING! It is not recommended to run this method too many times in a loop! The server receives
1625        many requests about the state of the portfolio, and then, based on the received data, a large number
1626        of calculation and statistics are collected.
1627
1628        :param show: if `False` then only dictionary returns, if `True` then show more debug information.
1629        :param details: how detailed should the information be?
1630        - `full` — shows full available information about portfolio status (by default),
1631        - `positions` — shows only open positions,
1632        - `orders` — shows only sections of open limits and stop orders.
1633        - `digest` — show a short digest of the portfolio status,
1634        - `analytics` — shows only the analytics section and the distribution of the portfolio by various categories,
1635        - `calendar` — shows only the bonds calendar section (if these present in portfolio),
1636        :return: dictionary with client's raw portfolio and some statistics.
1637        """
1638        if self.accountId is None or not self.accountId:
1639            uLogger.error("Variable `accountId` must be defined for using this method!")
1640            raise Exception("Account ID required")
1641
1642        view = {
1643            "raw": {  # --- raw portfolio responses from broker with user portfolio data:
1644                "headers": {},  # list of dictionaries, response headers without "positions" section
1645                "Currencies": [],  # list of dictionaries, open trades with currencies from "positions" section
1646                "Shares": [],  # list of dictionaries, open trades with shares from "positions" section
1647                "Bonds": [],  # list of dictionaries, open trades with bonds from "positions" section
1648                "Etfs": [],  # list of dictionaries, open trades with etfs from "positions" section
1649                "Futures": [],  # list of dictionaries, open trades with futures from "positions" section
1650                "positions": {},  # raw response from broker: dictionary with current available or blocked currencies and instruments for client
1651                "orders": [],  # raw response from broker: list of dictionaries with all pending (market) orders
1652                "stopOrders": [],  # raw response from broker: list of dictionaries with all stop orders
1653                "currenciesCurrentPrices": {"rub": {"name": "Российский рубль", "currentPrice": 1.}},  # dict with prices of all currencies in RUB
1654            },
1655            "stat": {  # --- some statistics calculated using "raw" sections:
1656                "portfolioCostRUB": 0.,  # portfolio cost in RUB (Russian Rouble)
1657                "availableRUB": 0.,  # available rubles (without other currencies)
1658                "blockedRUB": 0.,  # blocked sum in Russian Rouble
1659                "totalChangesRUB": 0.,  # changes for all open trades in RUB
1660                "totalChangesPercentRUB": 0.,  # changes for all open trades in percents
1661                "allCurrenciesCostRUB": 0.,  # costs of all currencies (include rubles) in RUB
1662                "sharesCostRUB": 0.,  # costs of all shares in RUB
1663                "bondsCostRUB": 0.,  # costs of all bonds in RUB
1664                "etfsCostRUB": 0.,  # costs of all etfs in RUB
1665                "futuresCostRUB": 0.,  # costs of all futures in RUB
1666                "Currencies": [],  # list of dictionaries of all currencies statistics
1667                "Shares": [],  # list of dictionaries of all shares statistics
1668                "Bonds": [],  # list of dictionaries of all bonds statistics
1669                "Etfs": [],  # list of dictionaries of all etfs statistics
1670                "Futures": [],  # list of dictionaries of all futures statistics
1671                "orders": [],  # list of dictionaries of all pending (market) orders and it's parameters
1672                "stopOrders": [],  # list of dictionaries of all stop orders and it's parameters
1673                "blockedCurrencies": {},  # dict with blocked instruments and currencies, e.g. {"rub": 1291.87, "usd": 6.21}
1674                "blockedInstruments": {},  # dict with blocked  by FIGI, e.g. {}
1675                "funds": {},  # dict with free funds for trading (total - blocked), by all currencies, e.g. {"rub": {"total": 10000.99, "totalCostRUB": 10000.99, "free": 1234.56, "freeCostRUB": 1234.56}, "usd": {"total": 250.55, "totalCostRUB": 15375.80, "free": 125.05, "freeCostRUB": 7687.50}}
1676            },
1677            "analytics": {  # --- some analytics of portfolio:
1678                "distrByAssets": {},  # portfolio distribution by assets
1679                "distrByCompanies": {},  # portfolio distribution by companies
1680                "distrBySectors": {},  # portfolio distribution by sectors
1681                "distrByCurrencies": {},  # portfolio distribution by currencies
1682                "distrByCountries": {},  # portfolio distribution by countries
1683                "bondsCalendar": None,  # bonds payment calendar as Pandas DataFrame (if these present in portfolio)
1684            }
1685        }
1686
1687        details = details.lower()
1688        availableDetails = ["full", "positions", "orders", "analytics", "calendar", "digest"]
1689        if details not in availableDetails:
1690            details = "full"
1691            uLogger.debug("Requested incorrect details! The `details` must be one of this strings: {}. Details parameter set to `full` be default.".format(availableDetails))
1692
1693        uLogger.debug("Requesting portfolio of a client. Wait, please...")
1694
1695        portfolioResponse = self.RequestPortfolio()  # current user's portfolio (dict)
1696        view["raw"]["positions"] = self.RequestPositions()  # current open positions by instruments (dict)
1697        view["raw"]["orders"] = self.RequestPendingOrders()  # current actual pending limit orders (list)
1698        view["raw"]["stopOrders"] = self.RequestStopOrders()  # current actual stop orders (list)
1699
1700        # save response headers without "positions" section:
1701        for key in portfolioResponse.keys():
1702            if key != "positions":
1703                view["raw"]["headers"][key] = portfolioResponse[key]
1704
1705            else:
1706                continue
1707
1708        # Re-sorting and separating given raw instruments and currencies by type: https://tinkoff.github.io/investAPI/operations/#operation
1709        # Type of instrument must be only one of supported types in TKS_INSTRUMENTS
1710        for item in portfolioResponse["positions"]:
1711            if item["instrumentType"] == "currency":
1712                self._figi = item["figi"]
1713                if not self._figi and item["ticker"]:
1714                    self._ticker = item["ticker"]
1715                    self._figi = self.SearchByTicker()["figi"]  # Get FIGI to avoid warnings
1716
1717                curr = self.SearchByFIGI(requestPrice=False)
1718
1719                # current price of currency in RUB:
1720                view["raw"]["currenciesCurrentPrices"][curr["nominal"]["currency"]] = {
1721                    "name": curr["name"],
1722                    "currentPrice": NanoToFloat(
1723                        item["currentPrice"]["units"],
1724                        item["currentPrice"]["nano"]
1725                    ),
1726                }
1727
1728                view["raw"]["Currencies"].append(item)
1729
1730            elif item["instrumentType"] == "share":
1731                view["raw"]["Shares"].append(item)
1732
1733            elif item["instrumentType"] == "bond":
1734                view["raw"]["Bonds"].append(item)
1735
1736            elif item["instrumentType"] == "etf":
1737                view["raw"]["Etfs"].append(item)
1738
1739            elif item["instrumentType"] == "futures":
1740                view["raw"]["Futures"].append(item)
1741
1742            else:
1743                continue
1744
1745        # how many volume of currencies (by ISO currency name) are blocked:
1746        for item in view["raw"]["positions"]["blocked"]:
1747            blocked = NanoToFloat(item["units"], item["nano"])
1748            if blocked > 0:
1749                view["stat"]["blockedCurrencies"][item["currency"]] = blocked
1750
1751        # how many volume of instruments (by FIGI) are blocked:
1752        for item in view["raw"]["positions"]["securities"]:
1753            blocked = int(item["blocked"])
1754            if blocked > 0:
1755                view["stat"]["blockedInstruments"][item["figi"]] = blocked
1756
1757        allBlocked = {**view["stat"]["blockedCurrencies"], **view["stat"]["blockedInstruments"]}
1758
1759        if "rub" in allBlocked.keys():
1760            view["stat"]["blockedRUB"] = allBlocked["rub"]  # blocked rubles
1761
1762        # --- saving current total amount in RUB of all currencies (with ruble), shares, bonds, etfs, futures and currencies:
1763        view["stat"]["allCurrenciesCostRUB"] = NanoToFloat(portfolioResponse["totalAmountCurrencies"]["units"], portfolioResponse["totalAmountCurrencies"]["nano"])
1764        view["stat"]["sharesCostRUB"] = NanoToFloat(portfolioResponse["totalAmountShares"]["units"], portfolioResponse["totalAmountShares"]["nano"])
1765        view["stat"]["bondsCostRUB"] = NanoToFloat(portfolioResponse["totalAmountBonds"]["units"], portfolioResponse["totalAmountBonds"]["nano"])
1766        view["stat"]["etfsCostRUB"] = NanoToFloat(portfolioResponse["totalAmountEtf"]["units"], portfolioResponse["totalAmountEtf"]["nano"])
1767        view["stat"]["futuresCostRUB"] = NanoToFloat(portfolioResponse["totalAmountFutures"]["units"], portfolioResponse["totalAmountFutures"]["nano"])
1768        view["stat"]["portfolioCostRUB"] = sum([
1769            view["stat"]["allCurrenciesCostRUB"],
1770            view["stat"]["sharesCostRUB"],
1771            view["stat"]["bondsCostRUB"],
1772            view["stat"]["etfsCostRUB"],
1773            view["stat"]["futuresCostRUB"],
1774        ])
1775
1776        # --- calculating some portfolio statistics:
1777        byComp = {}  # distribution by companies
1778        bySect = {}  # distribution by sectors
1779        byCurr = {}  # distribution by currencies (include RUB)
1780        unknownCountryName = "All other countries"  # default name for instruments without "countryOfRisk" and "countryOfRiskName"
1781        byCountry = {unknownCountryName: {"cost": 0, "percent": 0.}}  # distribution by countries (currencies are included in their countries)
1782
1783        for item in portfolioResponse["positions"]:
1784            self._figi = item["figi"]
1785            if not self._figi and item["ticker"]:
1786                self._ticker = item["ticker"]
1787                self._figi = self.SearchByTicker()["figi"]  # Get FIGI to avoid warnings
1788
1789            instrument = self.SearchByFIGI(requestPrice=False)  # full raw info about instrument by FIGI
1790
1791            if instrument:
1792                if item["instrumentType"] == "currency" and instrument["nominal"]["currency"] in allBlocked.keys():
1793                    blocked = allBlocked[instrument["nominal"]["currency"]]  # blocked volume of currency
1794
1795                elif item["instrumentType"] != "currency" and item["figi"] in allBlocked.keys():
1796                    blocked = allBlocked[item["figi"]]  # blocked volume of other instruments
1797
1798                else:
1799                    blocked = 0
1800
1801                volume = NanoToFloat(item["quantity"]["units"], item["quantity"]["nano"])  # available volume of instrument
1802                lots = NanoToFloat(item["quantityLots"]["units"], item["quantityLots"]["nano"])  # available volume in lots of instrument
1803                direction = "Long" if lots >= 0 else "Short"  # direction of an instrument's position: short or long
1804                curPrice = NanoToFloat(item["currentPrice"]["units"], item["currentPrice"]["nano"])  # current instrument's price
1805                average = NanoToFloat(item["averagePositionPriceFifo"]["units"], item["averagePositionPriceFifo"]["nano"])  # current average position price
1806                profit = NanoToFloat(item["expectedYield"]["units"], item["expectedYield"]["nano"])  # expected profit at current moment
1807                currency = instrument["currency"] if (item["instrumentType"] == "share" or item["instrumentType"] == "etf" or item["instrumentType"] == "future") else instrument["nominal"]["currency"]  # currency name rub, usd, eur etc.
1808                cost = curPrice if "currentNkd" not in item.keys() else (curPrice + NanoToFloat(item["currentNkd"]["units"], item["currentNkd"]["nano"])) * volume  # current cost of all volume of instrument in basic asset
1809                baseCurrencyName = item["currentPrice"]["currency"]  # name of base currency (rub)
1810                countryName = "[{}] {}".format(instrument["countryOfRisk"], instrument["countryOfRiskName"]) if "countryOfRisk" in instrument.keys() and "countryOfRiskName" in instrument.keys() and instrument["countryOfRisk"] and instrument["countryOfRiskName"] else unknownCountryName
1811                costRUB = cost if item["instrumentType"] == "currency" else cost * view["raw"]["currenciesCurrentPrices"][currency]["currentPrice"]  # cost in rubles
1812                percentCostRUB = 100 * costRUB / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.  # instrument's part in percent of full portfolio cost
1813
1814                statData = {
1815                    "figi": item["figi"],  # FIGI from REST API "GetPortfolio" method
1816                    "ticker": instrument["ticker"],  # ticker by FIGI
1817                    "currency": currency,  # currency name rub, usd, eur etc. for instrument price
1818                    "volume": volume,  # available volume of instrument
1819                    "lots": lots,  # volume in lots of instrument
1820                    "direction": direction,  # direction of an instrument's position: short or long
1821                    "blocked": blocked,  # blocked volume of currency or instrument
1822                    "currentPrice": curPrice,  # current instrument's price in basic asset
1823                    "average": average,  # current average position price
1824                    "cost": cost,  # current cost of all volume of instrument in basic asset
1825                    "baseCurrencyName": baseCurrencyName,  # name of base currency (rub)
1826                    "costRUB": costRUB,  # cost of instrument in ruble
1827                    "percentCostRUB": percentCostRUB,  # instrument's part in percent of full portfolio cost in RUB
1828                    "profit": profit,  # expected profit at current moment
1829                    "percentProfit": 100 * profit / (average * volume) if average != 0 and volume != 0 else 0,  # expected percents of profit at current moment for this instrument
1830                    "sector": instrument["sector"] if "sector" in instrument.keys() and instrument["sector"] else "other",
1831                    "name": instrument["name"] if "name" in instrument.keys() else "",  # human-readable names of instruments
1832                    "isoCurrencyName": instrument["isoCurrencyName"] if "isoCurrencyName" in instrument.keys() else "",  # ISO name for currencies only
1833                    "country": countryName,  # e.g. "[RU] Российская Федерация" or unknownCountryName
1834                    "step": instrument["step"],  # minimum price increment
1835                }
1836
1837                # adding distribution by unique countries:
1838                if statData["country"] not in byCountry.keys():
1839                    byCountry[statData["country"]] = {"cost": costRUB, "percent": percentCostRUB}
1840
1841                else:
1842                    byCountry[statData["country"]]["cost"] += costRUB
1843                    byCountry[statData["country"]]["percent"] += percentCostRUB
1844
1845                if item["instrumentType"] != "currency":
1846                    # adding distribution by unique companies:
1847                    if statData["name"]:
1848                        if statData["name"] not in byComp.keys():
1849                            byComp[statData["name"]] = {"ticker": statData["ticker"], "cost": costRUB, "percent": percentCostRUB}
1850
1851                        else:
1852                            byComp[statData["name"]]["cost"] += costRUB
1853                            byComp[statData["name"]]["percent"] += percentCostRUB
1854
1855                    # adding distribution by unique sectors:
1856                    if statData["sector"] not in bySect.keys():
1857                        bySect[statData["sector"]] = {"cost": costRUB, "percent": percentCostRUB}
1858
1859                    else:
1860                        bySect[statData["sector"]]["cost"] += costRUB
1861                        bySect[statData["sector"]]["percent"] += percentCostRUB
1862
1863                # adding distribution by unique currencies:
1864                if currency not in byCurr.keys():
1865                    byCurr[currency] = {
1866                        "name": view["raw"]["currenciesCurrentPrices"][currency]["name"],
1867                        "cost": costRUB,
1868                        "percent": percentCostRUB
1869                    }
1870
1871                else:
1872                    byCurr[currency]["cost"] += costRUB
1873                    byCurr[currency]["percent"] += percentCostRUB
1874
1875                # saving statistics for every instrument:
1876                if item["instrumentType"] == "currency":
1877                    view["stat"]["Currencies"].append(statData)
1878
1879                    # update dict with free funds for trading (total - blocked) by currencies
1880                    # e.g. {"rub": {"total": 10000.99, "totalCostRUB": 10000.99, "free": 1234.56, "freeCostRUB": 1234.56}, "usd": {"total": 250.55, "totalCostRUB": 15375.80, "free": 125.05, "freeCostRUB": 7687.50}}
1881                    view["stat"]["funds"][currency] = {
1882                        "total": volume,
1883                        "totalCostRUB": costRUB,  # total volume cost in rubles
1884                        "free": volume - blocked,
1885                        "freeCostRUB": costRUB * ((volume - blocked) / volume) if volume > 0 else 0,  # free volume cost in rubles
1886                    }
1887
1888                elif item["instrumentType"] == "share":
1889                    view["stat"]["Shares"].append(statData)
1890
1891                elif item["instrumentType"] == "bond":
1892                    view["stat"]["Bonds"].append(statData)
1893
1894                elif item["instrumentType"] == "etf":
1895                    view["stat"]["Etfs"].append(statData)
1896
1897                elif item["instrumentType"] == "Futures":
1898                    view["stat"]["Futures"].append(statData)
1899
1900                else:
1901                    continue
1902
1903        # total changes in Russian Ruble:
1904        view["stat"]["availableRUB"] = view["stat"]["allCurrenciesCostRUB"] - sum([item["cost"] for item in view["stat"]["Currencies"]])  # available RUB without other currencies
1905        view["stat"]["totalChangesPercentRUB"] = NanoToFloat(view["raw"]["headers"]["expectedYield"]["units"], view["raw"]["headers"]["expectedYield"]["nano"]) if "expectedYield" in view["raw"]["headers"].keys() else 0.
1906        startCost = view["stat"]["portfolioCostRUB"] / (1 + view["stat"]["totalChangesPercentRUB"] / 100)
1907        view["stat"]["totalChangesRUB"] = view["stat"]["portfolioCostRUB"] - startCost
1908        view["stat"]["funds"]["rub"] = {
1909            "total": view["stat"]["availableRUB"],
1910            "totalCostRUB": view["stat"]["availableRUB"],
1911            "free": view["stat"]["availableRUB"] - view["stat"]["blockedRUB"],
1912            "freeCostRUB": view["stat"]["availableRUB"] - view["stat"]["blockedRUB"],
1913        }
1914
1915        # --- pending limit orders sector data:
1916        uniquePendingOrdersFIGIs = []  # unique FIGIs of pending limit orders to avoid many times price requests
1917        uniquePendingOrders = {}  # unique instruments with FIGIs as dictionary keys
1918
1919        for item in view["raw"]["orders"]:
1920            self._figi = item["figi"]
1921
1922            if item["figi"] not in uniquePendingOrdersFIGIs:
1923                instrument = self.SearchByFIGI(requestPrice=True)  # full raw info about instrument by FIGI, price requests only one time
1924
1925                uniquePendingOrdersFIGIs.append(item["figi"])
1926                uniquePendingOrders[item["figi"]] = instrument
1927
1928            else:
1929                instrument = uniquePendingOrders[item["figi"]]
1930
1931            if instrument:
1932                action = TKS_ORDER_DIRECTIONS[item["direction"]]
1933                orderType = TKS_ORDER_TYPES[item["orderType"]]
1934                orderState = TKS_ORDER_STATES[item["executionReportStatus"]]
1935                orderDate = item["orderDate"].replace("T", " ").replace("Z", "").split(".")[0]  # date in UTC format, e.g. "2022-12-31T23:59:59.123456Z"
1936
1937                # current instrument's price (last sellers order if buy, and last buyers order if sell):
1938                if item["direction"] == "ORDER_DIRECTION_BUY":
1939                    lastPrice = instrument["currentPrice"]["sell"][0]["price"] if instrument["currentPrice"]["sell"] else "N/A"
1940
1941                else:
1942                    lastPrice = instrument["currentPrice"]["buy"][0]["price"] if instrument["currentPrice"]["buy"] else "N/A"
1943
1944                # requested price for order execution:
1945                target = NanoToFloat(item["initialSecurityPrice"]["units"], item["initialSecurityPrice"]["nano"])
1946
1947                # necessary changes in percent to reach target from current price:
1948                changes = 100 * (lastPrice - target) / target if lastPrice != "N/A" and target > 0 else 0
1949
1950                view["stat"]["orders"].append({
1951                    "orderID": item["orderId"],  # orderId number parameter of current order
1952                    "figi": item["figi"],  # FIGI identification
1953                    "ticker": instrument["ticker"],  # ticker name by FIGI
1954                    "lotsRequested": item["lotsRequested"],  # requested lots value
1955                    "lotsExecuted": item["lotsExecuted"],  # how many lots are executed
1956                    "currentPrice": lastPrice,  # current instrument's price for defined action
1957                    "targetPrice": target,  # requested price for order execution in base currency
1958                    "baseCurrencyName": item["initialSecurityPrice"]["currency"],  # name of base currency
1959                    "percentChanges": changes,  # changes in percent to target from current price
1960                    "currency": item["currency"],  # instrument's currency name
1961                    "action": action,  # sell / buy / Unknown from TKS_ORDER_DIRECTIONS
1962                    "type": orderType,  # type of order from TKS_ORDER_TYPES
1963                    "status": orderState,  # order status from TKS_ORDER_STATES
1964                    "date": orderDate,  # string with order date and time from UTC format (without nano seconds part)
1965                })
1966
1967        # --- stop orders sector data:
1968        uniqueStopOrdersFIGIs = []  # unique FIGIs of stop orders to avoid many times price requests
1969        uniqueStopOrders = {}  # unique instruments with FIGIs as dictionary keys
1970
1971        for item in view["raw"]["stopOrders"]:
1972            self._figi = item["figi"]
1973
1974            if item["figi"] not in uniqueStopOrdersFIGIs:
1975                instrument = self.SearchByFIGI(requestPrice=True)  # full raw info about instrument by FIGI, price requests only one time
1976
1977                uniqueStopOrdersFIGIs.append(item["figi"])
1978                uniqueStopOrders[item["figi"]] = instrument
1979
1980            else:
1981                instrument = uniqueStopOrders[item["figi"]]
1982
1983            if instrument:
1984                action = TKS_STOP_ORDER_DIRECTIONS[item["direction"]]
1985                orderType = TKS_STOP_ORDER_TYPES[item["orderType"]]
1986                createDate = item["createDate"].replace("T", " ").replace("Z", "").split(".")[0]  # date in UTC format, e.g. "2022-12-31T23:59:59.123456Z"
1987
1988                # hack: server response can't contain "expirationTime" key if it is not "Until date" type of stop order
1989                if "expirationTime" in item.keys():
1990                    expType = TKS_STOP_ORDER_EXPIRATION_TYPES["STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_DATE"]
1991                    expDate = item["expirationTime"].replace("T", " ").replace("Z", "").split(".")[0]
1992
1993                else:
1994                    expType = TKS_STOP_ORDER_EXPIRATION_TYPES["STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL"]
1995                    expDate = TKS_STOP_ORDER_EXPIRATION_TYPES["STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED"]
1996
1997                # current instrument's price (last sellers order if buy, and last buyers order if sell):
1998                if item["direction"] == "STOP_ORDER_DIRECTION_BUY":
1999                    lastPrice = instrument["currentPrice"]["sell"][0]["price"] if instrument["currentPrice"]["sell"] else "N/A"
2000
2001                else:
2002                    lastPrice = instrument["currentPrice"]["buy"][0]["price"] if instrument["currentPrice"]["buy"] else "N/A"
2003
2004                # requested price when stop-order executed:
2005                target = NanoToFloat(item["stopPrice"]["units"], item["stopPrice"]["nano"])
2006
2007                # price for limit-order, set up when stop-order executed:
2008                limit = NanoToFloat(item["price"]["units"], item["price"]["nano"])
2009
2010                # necessary changes in percent to reach target from current price:
2011                changes = 100 * (lastPrice - target) / target if lastPrice != "N/A" and target > 0 else 0
2012
2013                view["stat"]["stopOrders"].append({
2014                    "orderID": item["stopOrderId"],  # stopOrderId number parameter of current stop-order
2015                    "figi": item["figi"],  # FIGI identification
2016                    "ticker": instrument["ticker"],  # ticker name by FIGI
2017                    "lotsRequested": item["lotsRequested"],  # requested lots value
2018                    "currentPrice": lastPrice,  # current instrument's price for defined action
2019                    "targetPrice": target,  # requested price for stop-order execution in base currency
2020                    "limitPrice": limit,  # price for limit-order, set up when stop-order executed, 0 if market order
2021                    "baseCurrencyName": item["stopPrice"]["currency"],  # name of base currency
2022                    "percentChanges": changes,  # changes in percent to target from current price
2023                    "currency": item["currency"],  # instrument's currency name
2024                    "action": action,  # sell / buy / Unknown from TKS_STOP_ORDER_DIRECTIONS
2025                    "type": orderType,  # type of order from TKS_STOP_ORDER_TYPES
2026                    "expType": expType,  # expiration type of stop-order from TKS_STOP_ORDER_EXPIRATION_TYPES
2027                    "createDate": createDate,  # string with created order date and time from UTC format (without nano seconds part)
2028                    "expDate": expDate,  # string with expiration order date and time from UTC format (without nano seconds part)
2029                })
2030
2031        # --- calculating data for analytics section:
2032        # portfolio distribution by assets:
2033        view["analytics"]["distrByAssets"] = {
2034            "Ruble": {
2035                "uniques": 1,
2036                "cost": view["stat"]["availableRUB"],
2037                "percent": 100 * view["stat"]["availableRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2038            },
2039            "Currencies": {
2040                "uniques": len(view["stat"]["Currencies"]),  # all foreign currencies without RUB
2041                "cost": view["stat"]["allCurrenciesCostRUB"] - view["stat"]["availableRUB"],
2042                "percent": 100 * (view["stat"]["allCurrenciesCostRUB"] - view["stat"]["availableRUB"]) / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2043            },
2044            "Shares": {
2045                "uniques": len(view["stat"]["Shares"]),
2046                "cost": view["stat"]["sharesCostRUB"],
2047                "percent": 100 * view["stat"]["sharesCostRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2048            },
2049            "Bonds": {
2050                "uniques": len(view["stat"]["Bonds"]),
2051                "cost": view["stat"]["bondsCostRUB"],
2052                "percent": 100 * view["stat"]["bondsCostRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2053            },
2054            "Etfs": {
2055                "uniques": len(view["stat"]["Etfs"]),
2056                "cost": view["stat"]["etfsCostRUB"],
2057                "percent": 100 * view["stat"]["etfsCostRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2058            },
2059            "Futures": {
2060                "uniques": len(view["stat"]["Futures"]),
2061                "cost": view["stat"]["futuresCostRUB"],
2062                "percent": 100 * view["stat"]["futuresCostRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2063            },
2064        }
2065
2066        # portfolio distribution by companies:
2067        view["analytics"]["distrByCompanies"]["All money cash"] = {
2068            "ticker": "",
2069            "cost": view["stat"]["allCurrenciesCostRUB"],
2070            "percent": 100 * view["stat"]["allCurrenciesCostRUB"] / view["stat"]["portfolioCostRUB"] if view["stat"]["portfolioCostRUB"] > 0 else 0.,
2071        }
2072        view["analytics"]["distrByCompanies"].update(byComp)
2073
2074        # portfolio distribution by sectors:
2075        view["analytics"]["distrBySectors"]["All money cash"] = {
2076            "cost": view["analytics"]["distrByCompanies"]["All money cash"]["cost"],
2077            "percent": view["analytics"]["distrByCompanies"]["All money cash"]["percent"],
2078        }
2079        view["analytics"]["distrBySectors"].update(bySect)
2080
2081        # portfolio distribution by currencies:
2082        if "rub" not in view["analytics"]["distrByCurrencies"].keys():
2083            view["analytics"]["distrByCurrencies"]["rub"] = {"name": "Российский рубль", "cost": 0, "percent": 0}
2084
2085            if self.moreDebug:
2086                uLogger.debug("Fast hack to avoid issues #71 in `Portfolio distribution by currencies` section. Server not returned current available rubles!")
2087
2088        view["analytics"]["distrByCurrencies"].update(byCurr)
2089        view["analytics"]["distrByCurrencies"]["rub"]["cost"] += view["analytics"]["distrByAssets"]["Ruble"]["cost"]
2090        view["analytics"]["distrByCurrencies"]["rub"]["percent"] += view["analytics"]["distrByAssets"]["Ruble"]["percent"]
2091
2092        # portfolio distribution by countries:
2093        if "[RU] Российская Федерация" not in view["analytics"]["distrByCountries"].keys():
2094            view["analytics"]["distrByCountries"]["[RU] Российская Федерация"] = {"cost": 0, "percent": 0}
2095
2096            if self.moreDebug:
2097                uLogger.debug("Fast hack to avoid issues #71 in `Portfolio distribution by countries` section. Server not returned current available rubles!")
2098
2099        view["analytics"]["distrByCountries"].update(byCountry)
2100        view["analytics"]["distrByCountries"]["[RU] Российская Федерация"]["cost"] += view["analytics"]["distrByAssets"]["Ruble"]["cost"]
2101        view["analytics"]["distrByCountries"]["[RU] Российская Федерация"]["percent"] += view["analytics"]["distrByAssets"]["Ruble"]["percent"]
2102
2103        # --- Prepare text statistics overview in human-readable:
2104        if show:
2105            actualOnDate = datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)
2106
2107            # Whatever the value `details`, header not changes:
2108            info = [
2109                "# Client's portfolio\n\n",
2110                "* **Actual on date:** [{} UTC]\n".format(actualOnDate),
2111                "* **Account ID:** [{}]\n".format(self.accountId),
2112            ]
2113
2114            if details in ["full", "positions", "digest"]:
2115                info.extend([
2116                    "* **Portfolio cost:** {:.2f} RUB\n".format(view["stat"]["portfolioCostRUB"]),
2117                    "* **Changes:** {}{:.2f} RUB ({}{:.2f}%)\n\n".format(
2118                        "+" if view["stat"]["totalChangesRUB"] > 0 else "",
2119                        view["stat"]["totalChangesRUB"],
2120                        "+" if view["stat"]["totalChangesPercentRUB"] > 0 else "",
2121                        view["stat"]["totalChangesPercentRUB"],
2122                    ),
2123                ])
2124
2125            if details in ["full", "positions"]:
2126                info.extend([
2127                    "## Open positions\n\n",
2128                    "| Ticker [FIGI]               | Volume (blocked)                | Lots     | Curr. price  | Avg. price   | Current volume cost | Profit (%)                   |\n",
2129                    "|-----------------------------|---------------------------------|----------|--------------|--------------|---------------------|------------------------------|\n",
2130                    "| **Ruble:**                  | {:>31} |          |              |              |                     |                              |\n".format(
2131                        "{:.2f} ({:.2f}) rub".format(
2132                            view["stat"]["availableRUB"],
2133                            view["stat"]["blockedRUB"],
2134                        )
2135                    )
2136                ])
2137
2138                def _SplitStr(CostRUB: float = 0, typeStr: str = "", noTradeStr: str = "") -> list:
2139                    return [
2140                        "|                             |                                 |          |              |              |                     |                              |\n",
2141                        "| {:<27} |                                 |          |              |              | {:>19} |                              |\n".format(
2142                            noTradeStr if noTradeStr else typeStr,
2143                            "" if noTradeStr else "{:.2f} RUB".format(CostRUB),
2144                        ),
2145                    ]
2146
2147                def _InfoStr(data: dict, isCurr: bool = False) -> str:
2148                    return "| {:<27} | {:>31} | {:<8} | {:>12} | {:>12} | {:>19} | {:<28} |\n".format(
2149                        "{} [{}]".format(data["ticker"], data["figi"]),
2150                        "{:.2f} ({:.2f}) {}".format(
2151                            data["volume"],
2152                            data["blocked"],
2153                            data["currency"],
2154                        ) if isCurr else "{:.0f} ({:.0f})".format(
2155                            data["volume"],
2156                            data["blocked"],
2157                        ),
2158                        "—" if isCurr else "{:.4f}".format(data["lots"]).rstrip("0").rstrip("."),
2159                        "{:.2f} {}".format(data["currentPrice"], data["baseCurrencyName"]) if data["currentPrice"] > 0 else "n/a",
2160                        "{:.2f} {}".format(data["average"], data["baseCurrencyName"]) if data["average"] > 0 else "n/a",
2161                        "{:.2f} {}".format(data["cost"], data["baseCurrencyName"]),
2162                        "{}{:.2f} {} ({}{:.2f}%)".format(
2163                            "+" if data["profit"] > 0 else "",
2164                            data["profit"], data["baseCurrencyName"],
2165                            "+" if data["percentProfit"] > 0 else "",
2166                            data["percentProfit"],
2167                        ),
2168                    )
2169
2170                # --- Show currencies section:
2171                if view["stat"]["Currencies"]:
2172                    info.extend(_SplitStr(CostRUB=view["analytics"]["distrByAssets"]["Currencies"]["cost"], typeStr="**Currencies:**"))
2173                    for item in view["stat"]["Currencies"]:
2174                        info.append(_InfoStr(item, isCurr=True))
2175
2176                else:
2177                    info.extend(_SplitStr(noTradeStr="**Currencies:** no trades"))
2178
2179                # --- Show shares section:
2180                if view["stat"]["Shares"]:
2181                    info.extend(_SplitStr(CostRUB=view["stat"]["sharesCostRUB"], typeStr="**Shares:**"))
2182
2183                    for item in view["stat"]["Shares"]:
2184                        info.append(_InfoStr(item))
2185
2186                else:
2187                    info.extend(_SplitStr(noTradeStr="**Shares:** no trades"))
2188
2189                # --- Show bonds section:
2190                if view["stat"]["Bonds"]:
2191                    info.extend(_SplitStr(CostRUB=view["stat"]["bondsCostRUB"], typeStr="**Bonds:**"))
2192
2193                    for item in view["stat"]["Bonds"]:
2194                        info.append(_InfoStr(item))
2195
2196                else:
2197                    info.extend(_SplitStr(noTradeStr="**Bonds:** no trades"))
2198
2199                # --- Show etfs section:
2200                if view["stat"]["Etfs"]:
2201                    info.extend(_SplitStr(CostRUB=view["stat"]["etfsCostRUB"], typeStr="**Etfs:**"))
2202
2203                    for item in view["stat"]["Etfs"]:
2204                        info.append(_InfoStr(item))
2205
2206                else:
2207                    info.extend(_SplitStr(noTradeStr="**Etfs:** no trades"))
2208
2209                # --- Show futures section:
2210                if view["stat"]["Futures"]:
2211                    info.extend(_SplitStr(CostRUB=view["stat"]["futuresCostRUB"], typeStr="**Futures:**"))
2212
2213                    for item in view["stat"]["Futures"]:
2214                        info.append(_InfoStr(item))
2215
2216                else:
2217                    info.extend(_SplitStr(noTradeStr="**Futures:** no trades"))
2218
2219            if details in ["full", "orders"]:
2220                # --- Show pending limit orders section:
2221                if view["stat"]["orders"]:
2222                    info.extend([
2223                        "\n## Opened pending limit-orders: [{}]\n".format(len(view["stat"]["orders"])),
2224                        "\n| Ticker [FIGI]               | Order ID       | Lots (exec.) | Current price (% delta) | Target price  | Action    | Type      | Create date (UTC)       |\n",
2225                        "|-----------------------------|----------------|--------------|-------------------------|---------------|-----------|-----------|-------------------------|\n",
2226                    ])
2227
2228                    for item in view["stat"]["orders"]:
2229                        info.append("| {:<27} | {:<14} | {:<12} | {:>23} | {:>13} | {:<9} | {:<9} | {:<23} |\n".format(
2230                            "{} [{}]".format(item["ticker"], item["figi"]),
2231                            item["orderID"],
2232                            "{} ({})".format(item["lotsRequested"], item["lotsExecuted"]),
2233                            "{} {} ({}{:.2f}%)".format(
2234                                "{}".format(item["currentPrice"]) if isinstance(item["currentPrice"], str) else "{:.2f}".format(float(item["currentPrice"])),
2235                                item["baseCurrencyName"],
2236                                "+" if item["percentChanges"] > 0 else "",
2237                                float(item["percentChanges"]),
2238                            ),
2239                            "{:.2f} {}".format(float(item["targetPrice"]), item["baseCurrencyName"]),
2240                            item["action"],
2241                            item["type"],
2242                            item["date"],
2243                        ))
2244
2245                else:
2246                    info.append("\n## Total pending limit-orders: [0]\n")
2247
2248                # --- Show stop orders section:
2249                if view["stat"]["stopOrders"]:
2250                    info.extend([
2251                        "\n## Opened stop-orders: [{}]\n".format(len(view["stat"]["stopOrders"])),
2252                        "\n| Ticker [FIGI]               | Stop order ID                        | Lots   | Current price (% delta) | Target price  | Limit price   | Action    | Type        | Expire type  | Create date (UTC)   | Expiration (UTC)    |\n",
2253                        "|-----------------------------|--------------------------------------|--------|-------------------------|---------------|---------------|-----------|-------------|--------------|---------------------|---------------------|\n",
2254                    ])
2255
2256                    for item in view["stat"]["stopOrders"]:
2257                        info.append("| {:<27} | {:<14} | {:<6} | {:>23} | {:>13} | {:>13} | {:<9} | {:<11} | {:<12} | {:<19} | {:<19} |\n".format(
2258                            "{} [{}]".format(item["ticker"], item["figi"]),
2259                            item["orderID"],
2260                            item["lotsRequested"],
2261                            "{} {} ({}{:.2f}%)".format(
2262                                "{}".format(item["currentPrice"]) if isinstance(item["currentPrice"], str) else "{:.2f}".format(float(item["currentPrice"])),
2263                                item["baseCurrencyName"],
2264                                "+" if item["percentChanges"] > 0 else "",
2265                                float(item["percentChanges"]),
2266                            ),
2267                            "{:.2f} {}".format(float(item["targetPrice"]), item["baseCurrencyName"]),
2268                            "{:.2f} {}".format(float(item["limitPrice"]), item["baseCurrencyName"]) if item["limitPrice"] and item["limitPrice"] != item["targetPrice"] else TKS_ORDER_TYPES["ORDER_TYPE_MARKET"],
2269                            item["action"],
2270                            item["type"],
2271                            item["expType"],
2272                            item["createDate"],
2273                            item["expDate"],
2274                        ))
2275
2276                else:
2277                    info.append("\n## Total stop-orders: [0]\n")
2278
2279            if details in ["full", "analytics"]:
2280                # -- Show analytics section:
2281                if view["stat"]["portfolioCostRUB"] > 0:
2282                    info.extend([
2283                        "\n# Analytics\n\n"
2284                        "* **Actual on date:** [{} UTC]\n".format(actualOnDate),
2285                        "* **Current total portfolio cost:** {:.2f} RUB\n".format(view["stat"]["portfolioCostRUB"]),
2286                        "* **Changes:** {}{:.2f} RUB ({}{:.2f}%)\n".format(
2287                            "+" if view["stat"]["totalChangesRUB"] > 0 else "",
2288                            view["stat"]["totalChangesRUB"],
2289                            "+" if view["stat"]["totalChangesPercentRUB"] > 0 else "",
2290                            view["stat"]["totalChangesPercentRUB"],
2291                        ),
2292                        "\n## Portfolio distribution by assets\n"
2293                        "\n| Type                               | Uniques | Percent | Current cost       |\n",
2294                        "|------------------------------------|---------|---------|--------------------|\n",
2295                    ])
2296
2297                    for key in view["analytics"]["distrByAssets"].keys():
2298                        if view["analytics"]["distrByAssets"][key]["cost"] > 0:
2299                            info.append("| {:<34} | {:<7} | {:<7} | {:<18} |\n".format(
2300                                key,
2301                                view["analytics"]["distrByAssets"][key]["uniques"],
2302                                "{:.2f}%".format(view["analytics"]["distrByAssets"][key]["percent"]),
2303                                "{:.2f} rub".format(view["analytics"]["distrByAssets"][key]["cost"]),
2304                            ))
2305
2306                    aSepLine = "|----------------------------------------------|---------|--------------------|\n"
2307
2308                    info.extend([
2309                        "\n## Portfolio distribution by companies\n"
2310                        "\n| Company                                      | Percent | Current cost       |\n",
2311                        aSepLine,
2312                    ])
2313
2314                    for company in view["analytics"]["distrByCompanies"].keys():
2315                        if view["analytics"]["distrByCompanies"][company]["cost"] > 0:
2316                            info.append("| {:<44} | {:<7} | {:<18} |\n".format(
2317                                "{}{}".format(
2318                                    "[{}] ".format(view["analytics"]["distrByCompanies"][company]["ticker"]) if view["analytics"]["distrByCompanies"][company]["ticker"] else "",
2319                                    company,
2320                                ),
2321                                "{:.2f}%".format(view["analytics"]["distrByCompanies"][company]["percent"]),
2322                                "{:.2f} rub".format(view["analytics"]["distrByCompanies"][company]["cost"]),
2323                            ))
2324
2325                    info.extend([
2326                        "\n## Portfolio distribution by sectors\n"
2327                        "\n| Sector                                       | Percent | Current cost       |\n",
2328                        aSepLine,
2329                    ])
2330
2331                    for sector in view["analytics"]["distrBySectors"].keys():
2332                        if view["analytics"]["distrBySectors"][sector]["cost"] > 0:
2333                            info.append("| {:<44} | {:<7} | {:<18} |\n".format(
2334                                sector,
2335                                "{:.2f}%".format(view["analytics"]["distrBySectors"][sector]["percent"]),
2336                                "{:.2f} rub".format(view["analytics"]["distrBySectors"][sector]["cost"]),
2337                            ))
2338
2339                    info.extend([
2340                        "\n## Portfolio distribution by currencies\n"
2341                        "\n| Instruments currencies                       | Percent | Current cost       |\n",
2342                        aSepLine,
2343                    ])
2344
2345                    for curr in view["analytics"]["distrByCurrencies"].keys():
2346                        if view["analytics"]["distrByCurrencies"][curr]["cost"] > 0:
2347                            info.append("| {:<44} | {:<7} | {:<18} |\n".format(
2348                                "[{}] {}".format(curr, view["analytics"]["distrByCurrencies"][curr]["name"]),
2349                                "{:.2f}%".format(view["analytics"]["distrByCurrencies"][curr]["percent"]),
2350                                "{:.2f} rub".format(view["analytics"]["distrByCurrencies"][curr]["cost"]),
2351                            ))
2352
2353                    info.extend([
2354                        "\n## Portfolio distribution by countries\n"
2355                        "\n| Assets by country                            | Percent | Current cost       |\n",
2356                        aSepLine,
2357                    ])
2358
2359                    for country in view["analytics"]["distrByCountries"].keys():
2360                        if view["analytics"]["distrByCountries"][country]["cost"] > 0:
2361                            info.append("| {:<44} | {:<7} | {:<18} |\n".format(
2362                                country,
2363                                "{:.2f}%".format(view["analytics"]["distrByCountries"][country]["percent"]),
2364                                "{:.2f} rub".format(view["analytics"]["distrByCountries"][country]["cost"]),
2365                            ))
2366
2367            if details in ["full", "calendar"]:
2368                # -- Show bonds payment calendar section:
2369                if view["stat"]["Bonds"]:
2370                    bondTickers = [item["ticker"] for item in view["stat"]["Bonds"]]
2371                    view["analytics"]["bondsCalendar"] = self.ExtendBondsData(instruments=bondTickers, xlsx=False)
2372                    info.append("\n" + self.ShowBondsCalendar(extBonds=view["analytics"]["bondsCalendar"], show=False))
2373
2374                else:
2375                    info.append("\n# Bond payments calendar\n\nNo bonds in the portfolio to create payments calendar\n")
2376
2377            infoText = "".join(info)
2378
2379            uLogger.info(infoText)
2380
2381            if details == "full" and self.overviewFile:
2382                filename = self.overviewFile
2383
2384            elif details == "digest" and self.overviewDigestFile:
2385                filename = self.overviewDigestFile
2386
2387            elif details == "positions" and self.overviewPositionsFile:
2388                filename = self.overviewPositionsFile
2389
2390            elif details == "orders" and self.overviewOrdersFile:
2391                filename = self.overviewOrdersFile
2392
2393            elif details == "analytics" and self.overviewAnalyticsFile:
2394                filename = self.overviewAnalyticsFile
2395
2396            elif details == "calendar" and self.overviewBondsCalendarFile:
2397                filename = self.overviewBondsCalendarFile
2398
2399            else:
2400                filename = ""
2401
2402            if filename:
2403                with open(filename, "w", encoding="UTF-8") as fH:
2404                    fH.write(infoText)
2405
2406                uLogger.info("Client's portfolio was saved to file: [{}]".format(os.path.abspath(filename)))
2407
2408                if self.useHTMLReports:
2409                    htmlFilePath = filename.replace(".md", ".html") if filename.endswith(".md") else filename + ".html"
2410                    with open(htmlFilePath, "w", encoding="UTF-8") as fH:
2411                        fH.write(Template(text=MAIN_INFO_TEMPLATE).render(mainTitle="Client's portfolio", commonCSS=COMMON_CSS, markdown=infoText))
2412
2413                    uLogger.info("The report has also been converted to an HTML file: [{}]".format(os.path.abspath(htmlFilePath)))
2414
2415        return view
2416
2417    def Deals(self, start: str = None, end: str = None, show: bool = False, showCancelled: bool = True) -> tuple[list[dict], dict]:
2418        """
2419        Returns history operations between two given dates for current `accountId`.
2420        If `reportFile` string is not empty then also save human-readable report.
2421        Shows some statistical data of closed positions.
2422
2423        :param start: see docstring in `TradeRoutines.GetDatesAsString()` method.
2424        :param end: see docstring in `TradeRoutines.GetDatesAsString()` method.
2425        :param show: if `True` then also prints all records to the console.
2426        :param showCancelled: if `False` then remove information about cancelled operations from the deals report.
2427        :return: original list of dictionaries with history of deals records from API ("operations" key):
2428                 https://tinkoff.github.io/investAPI/swagger-ui/#/OperationsService/OperationsService_GetOperations
2429                 and dictionary with custom stats: operations in different currencies, withdrawals, incomes etc.
2430        """
2431        if self.accountId is None or not self.accountId:
2432            uLogger.error("Variable `accountId` must be defined for using this method!")
2433            raise Exception("Account ID required")
2434
2435        startDate, endDate = GetDatesAsString(start, end, userFormat=TKS_DATE_FORMAT, outputFormat=TKS_DATE_TIME_FORMAT)  # Example: ("2000-01-01T00:00:00Z", "2022-12-31T23:59:59Z")
2436
2437        uLogger.debug("Requesting history of a client's operations. Wait, please...")
2438
2439        # REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/OperationsService/OperationsService_GetOperations
2440        dealsURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OperationsService/GetOperations"
2441        self.body = str({"accountId": self.accountId, "from": startDate, "to": endDate})
2442        ops = self.SendAPIRequest(dealsURL, reqType="POST")["operations"]  # list of dict: operations returns by broker
2443        customStat = {}  # custom statistics in additional to responseJSON
2444
2445        # --- output report in human-readable format:
2446        if show or self.reportFile:
2447            splitLine1 = "|                            |                               |                              |                      |                        |\n"  # Summary section
2448            splitLine2 = "|                     |              |              |            |           |                 |            |                                                                    |\n"  # Operations section
2449            nextDay = ""
2450
2451            info = ["# Client's operations\n\n* **Period:** from [{}] to [{}]\n\n## Summary (operations executed only)\n\n".format(startDate.split("T")[0], endDate.split("T")[0])]
2452
2453            if len(ops) > 0:
2454                customStat = {
2455                    "opsCount": 0,  # total operations count
2456                    "buyCount": 0,  # buy operations
2457                    "sellCount": 0,  # sell operations
2458                    "buyTotal": {"rub": 0.},  # Buy sums in different currencies
2459                    "sellTotal": {"rub": 0.},  # Sell sums in different currencies
2460                    "payIn": {"rub": 0.},  # Deposit brokerage account
2461                    "payOut": {"rub": 0.},  # Withdrawals
2462                    "divs": {"rub": 0.},  # Dividends income
2463                    "coupons": {"rub": 0.},  # Coupon's income
2464                    "brokerCom": {"rub": 0.},  # Service commissions
2465                    "serviceCom": {"rub": 0.},  # Service commissions
2466                    "marginCom": {"rub": 0.},  # Margin commissions
2467                    "allTaxes": {"rub": 0.},  # Sum of withholding taxes and corrections
2468                }
2469
2470                # --- calculating statistics depends on operations type in TKS_OPERATION_TYPES:
2471                for item in ops:
2472                    if item["state"] == "OPERATION_STATE_EXECUTED":
2473                        payment = NanoToFloat(item["payment"]["units"], item["payment"]["nano"])
2474
2475                        # count buy operations:
2476                        if "_BUY" in item["operationType"]:
2477                            customStat["buyCount"] += 1
2478
2479                            if item["payment"]["currency"] in customStat["buyTotal"].keys():
2480                                customStat["buyTotal"][item["payment"]["currency"]] += payment
2481
2482                            else:
2483                                customStat["buyTotal"][item["payment"]["currency"]] = payment
2484
2485                        # count sell operations:
2486                        elif "_SELL" in item["operationType"]:
2487                            customStat["sellCount"] += 1
2488
2489                            if item["payment"]["currency"] in customStat["sellTotal"].keys():
2490                                customStat["sellTotal"][item["payment"]["currency"]] += payment
2491
2492                            else:
2493                                customStat["sellTotal"][item["payment"]["currency"]] = payment
2494
2495                        # count incoming operations:
2496                        elif item["operationType"] in ["OPERATION_TYPE_INPUT"]:
2497                            if item["payment"]["currency"] in customStat["payIn"].keys():
2498                                customStat["payIn"][item["payment"]["currency"]] += payment
2499
2500                            else:
2501                                customStat["payIn"][item["payment"]["currency"]] = payment
2502
2503                        # count withdrawals operations:
2504                        elif item["operationType"] in ["OPERATION_TYPE_OUTPUT"]:
2505                            if item["payment"]["currency"] in customStat["payOut"].keys():
2506                                customStat["payOut"][item["payment"]["currency"]] += payment
2507
2508                            else:
2509                                customStat["payOut"][item["payment"]["currency"]] = payment
2510
2511                        # count dividends income:
2512                        elif item["operationType"] in ["OPERATION_TYPE_DIVIDEND", "OPERATION_TYPE_DIVIDEND_TRANSFER", "OPERATION_TYPE_DIV_EXT"]:
2513                            if item["payment"]["currency"] in customStat["divs"].keys():
2514                                customStat["divs"][item["payment"]["currency"]] += payment
2515
2516                            else:
2517                                customStat["divs"][item["payment"]["currency"]] = payment
2518
2519                        # count coupon's income:
2520                        elif item["operationType"] in ["OPERATION_TYPE_COUPON", "OPERATION_TYPE_BOND_REPAYMENT_FULL", "OPERATION_TYPE_BOND_REPAYMENT"]:
2521                            if item["payment"]["currency"] in customStat["coupons"].keys():
2522                                customStat["coupons"][item["payment"]["currency"]] += payment
2523
2524                            else:
2525                                customStat["coupons"][item["payment"]["currency"]] = payment
2526
2527                        # count broker commissions:
2528                        elif item["operationType"] in ["OPERATION_TYPE_BROKER_FEE", "OPERATION_TYPE_SUCCESS_FEE", "OPERATION_TYPE_TRACK_MFEE", "OPERATION_TYPE_TRACK_PFEE"]:
2529                            if item["payment"]["currency"] in customStat["brokerCom"].keys():
2530                                customStat["brokerCom"][item["payment"]["currency"]] += payment
2531
2532                            else:
2533                                customStat["brokerCom"][item["payment"]["currency"]] = payment
2534
2535                        # count service commissions:
2536                        elif item["operationType"] in ["OPERATION_TYPE_SERVICE_FEE"]:
2537                            if item["payment"]["currency"] in customStat["serviceCom"].keys():
2538                                customStat["serviceCom"][item["payment"]["currency"]] += payment
2539
2540                            else:
2541                                customStat["serviceCom"][item["payment"]["currency"]] = payment
2542
2543                        # count margin commissions:
2544                        elif item["operationType"] in ["OPERATION_TYPE_MARGIN_FEE"]:
2545                            if item["payment"]["currency"] in customStat["marginCom"].keys():
2546                                customStat["marginCom"][item["payment"]["currency"]] += payment
2547
2548                            else:
2549                                customStat["marginCom"][item["payment"]["currency"]] = payment
2550
2551                        # count withholding taxes:
2552                        elif "_TAX" in item["operationType"]:
2553                            if item["payment"]["currency"] in customStat["allTaxes"].keys():
2554                                customStat["allTaxes"][item["payment"]["currency"]] += payment
2555
2556                            else:
2557                                customStat["allTaxes"][item["payment"]["currency"]] = payment
2558
2559                        else:
2560                            continue
2561
2562                customStat["opsCount"] += customStat["buyCount"] + customStat["sellCount"]
2563
2564                # --- view "Actions" lines:
2565                info.extend([
2566                    "| Report sections            |                               |                              |                      |                        |\n",
2567                    "|----------------------------|-------------------------------|------------------------------|----------------------|------------------------|\n",
2568                    "| **Actions:**               | Trades: {:<21} | Trading volumes:             |                      |                        |\n".format(customStat["opsCount"]),
2569                    "|                            |   Buy: {:<22} | {:<28} |                      |                        |\n".format(
2570                        "{} ({:.1f}%)".format(customStat["buyCount"], 100 * customStat["buyCount"] / customStat["opsCount"]) if customStat["opsCount"] != 0 else 0,
2571                        "  rub, buy: {:<16}".format("{:.2f}".format(customStat["buyTotal"]["rub"])) if customStat["buyTotal"]["rub"] != 0 else "  —",
2572                    ),
2573                    "|                            |   Sell: {:<21} | {:<28} |                      |                        |\n".format(
2574                        "{} ({:.1f}%)".format(customStat["sellCount"], 100 * customStat["sellCount"] / customStat["opsCount"]) if customStat["opsCount"] != 0 else 0,
2575                        "  rub, sell: {:<13}".format("+{:.2f}".format(customStat["sellTotal"]["rub"])) if customStat["sellTotal"]["rub"] != 0 else "  —",
2576                    ),
2577                ])
2578
2579                opsKeys = sorted(list(set(list(customStat["buyTotal"].keys()) + list(customStat["sellTotal"].keys()))))
2580                for key in opsKeys:
2581                    if key == "rub":
2582                        continue
2583
2584                    info.extend([
2585                        "|                            |                               | {:<28} |                      |                        |\n".format(
2586                            "  {}, buy: {:<16}".format(key, "{:.2f}".format(customStat["buyTotal"][key]) if key and key in customStat["buyTotal"].keys() and customStat["buyTotal"][key] != 0 else 0)
2587                        ),
2588                        "|                            |                               | {:<28} |                      |                        |\n".format(
2589                            "  {}, sell: {:<13}".format(key, "+{:.2f}".format(customStat["sellTotal"][key]) if key and key in customStat["sellTotal"].keys() and customStat["sellTotal"][key] != 0 else 0)
2590                        ),
2591                    ])
2592
2593                info.append(splitLine1)
2594
2595                def _InfoStr(data1: dict, data2: dict, data3: dict, data4: dict, cur: str = "") -> str:
2596                    return "|                            | {:<29} | {:<28} | {:<20} | {:<22} |\n".format(
2597                            "  {}: {}{:.2f}".format(cur, "+" if data1[cur] > 0 else "", data1[cur]) if cur and cur in data1.keys() and data1[cur] != 0 else "  —",
2598                            "  {}: {}{:.2f}".format(cur, "+" if data2[cur] > 0 else "", data2[cur]) if cur and cur in data2.keys() and data2[cur] != 0 else "  —",
2599                            "  {}: {}{:.2f}".format(cur, "+" if data3[cur] > 0 else "", data3[cur]) if cur and cur in data3.keys() and data3[cur] != 0 else "  —",
2600                            "  {}: {}{:.2f}".format(cur, "+" if data4[cur] > 0 else "", data4[cur]) if cur and cur in data4.keys() and data4[cur] != 0 else "  —",
2601                    )
2602
2603                # --- view "Payments" lines:
2604                info.append("| **Payments:**              | Deposit on broker account:    | Withdrawals:                 | Dividends income:    | Coupons income:        |\n")
2605                paymentsKeys = sorted(list(set(list(customStat["payIn"].keys()) + list(customStat["payOut"].keys()) + list(customStat["divs"].keys()) + list(customStat["coupons"].keys()))))
2606
2607                for key in paymentsKeys:
2608                    info.append(_InfoStr(customStat["payIn"], customStat["payOut"], customStat["divs"], customStat["coupons"], key))
2609
2610                info.append(splitLine1)
2611
2612                # --- view "Commissions and taxes" lines:
2613                info.append("| **Commissions and taxes:** | Broker commissions:           | Service commissions:         | Margin commissions:  | All taxes/corrections: |\n")
2614                comKeys = sorted(list(set(list(customStat["brokerCom"].keys()) + list(customStat["serviceCom"].keys()) + list(customStat["marginCom"].keys()) + list(customStat["allTaxes"].keys()))))
2615
2616                for key in comKeys:
2617                    info.append(_InfoStr(customStat["brokerCom"], customStat["serviceCom"], customStat["marginCom"], customStat["allTaxes"], key))
2618
2619                info.extend([
2620                    "\n## All operations{}\n\n".format("" if showCancelled else " (without cancelled status)"),
2621                    "| Date and time       | FIGI         | Ticker       | Asset      | Value     | Payment         | Status     | Operation type                                                     |\n",
2622                    "|---------------------|--------------|--------------|------------|-----------|-----------------|------------|--------------------------------------------------------------------|\n",
2623                ])
2624
2625            else:
2626                info.append("Broker returned no operations during this period\n")
2627
2628            # --- view "Operations" section:
2629            for item in ops:
2630                if not showCancelled and TKS_OPERATION_STATES[item["state"]] == TKS_OPERATION_STATES["OPERATION_STATE_CANCELED"]:
2631                    continue
2632
2633                else:
2634                    self._figi = item["figi"]
2635                    payment = NanoToFloat(item["payment"]["units"], item["payment"]["nano"])
2636                    instrument = self.SearchByFIGI(requestPrice=False) if self._figi else {}
2637
2638                    # group of deals during one day:
2639                    if nextDay and item["date"].split("T")[0] != nextDay:
2640                        info.append(splitLine2)
2641                        nextDay = ""
2642
2643                    else:
2644                        nextDay = item["date"].split("T")[0]  # saving current day for splitting
2645
2646                    info.append("| {:<19} | {:<12} | {:<12} | {:<10} | {:<9} | {:>15} | {:<10} | {:<66} |\n".format(
2647                        item["date"].replace("T", " ").replace("Z", "").split(".")[0],
2648                        self._figi if self._figi else "—",
2649                        instrument["ticker"] if instrument else "—",
2650                        instrument["type"] if instrument else "—",
2651                        item["quantity"] if int(item["quantity"]) > 0 else "—",
2652                        "{}{:.2f} {}".format("+" if payment > 0 else "", payment, item["payment"]["currency"]) if payment != 0 else "—",
2653                        TKS_OPERATION_STATES[item["state"]],
2654                        TKS_OPERATION_TYPES[item["operationType"]],
2655                    ))
2656
2657            infoText = "".join(info)
2658
2659            if show:
2660                if self.moreDebug:
2661                    uLogger.debug("Records about history of a client's operations successfully received")
2662
2663                uLogger.info(infoText)
2664
2665            if self.reportFile:
2666                with open(self.reportFile, "w", encoding="UTF-8") as fH:
2667                    fH.write(infoText)
2668
2669                uLogger.info("History of a client's operations are saved to file: [{}]".format(os.path.abspath(self.reportFile)))
2670
2671                if self.useHTMLReports:
2672                    htmlFilePath = self.reportFile.replace(".md", ".html") if self.reportFile.endswith(".md") else self.reportFile + ".html"
2673                    with open(htmlFilePath, "w", encoding="UTF-8") as fH:
2674                        fH.write(Template(text=MAIN_INFO_TEMPLATE).render(mainTitle="Client's operations", commonCSS=COMMON_CSS, markdown=infoText))
2675
2676                    uLogger.info("The report has also been converted to an HTML file: [{}]".format(os.path.abspath(htmlFilePath)))
2677
2678        return ops, customStat
2679
2680    def History(self, start: str = None, end: str = None, interval: str = "hour", onlyMissing: bool = False, csvSep: str = ",", show: bool = False) -> pd.DataFrame:
2681        """
2682        This method returns last history candles of the current instrument defined by `ticker` or `figi` (FIGI id).
2683
2684        History returned between two given dates: `start` and `end`. Minimum requested date in the past is `1970-01-01`.
2685        Warning! Broker server used ISO UTC time by default.
2686
2687        If `historyFile` is not `None` then method save history to file, otherwise return only Pandas DataFrame.
2688        Also, `historyFile` used to update history with `onlyMissing` parameter.
2689
2690        See also: `LoadHistory()` and `ShowHistoryChart()` methods.
2691
2692        :param start: see docstring in `TradeRoutines.GetDatesAsString()` method.
2693        :param end: see docstring in `TradeRoutines.GetDatesAsString()` method.
2694        :param interval: this is a candle interval. Current available values are `"1min"`, `"5min"`, `"15min"`,
2695                         `"hour"`, `"day"`. Default: `"hour"`.
2696        :param onlyMissing: if `True` then add only last missing candles, do not request all history length from `start`.
2697                            False by default. Warning! History appends only from last candle to current time
2698                            with always update last candle!
2699        :param csvSep: separator if csv-file is used, `,` by default.
2700        :param show: if `True` then also prints Pandas DataFrame to the console.
2701        :return: Pandas DataFrame with prices history. Headers of columns are defined by default:
2702                 `["date", "time", "open", "high", "low", "close", "volume"]`.
2703        """
2704        strStartDate, strEndDate = GetDatesAsString(start, end, userFormat=TKS_DATE_FORMAT, outputFormat=TKS_DATE_TIME_FORMAT)  # example: ("2020-01-01T00:00:00Z", "2022-12-31T23:59:59Z")
2705        headers = ["date", "time", "open", "high", "low", "close", "volume"]  # sequence and names of column headers
2706        history = None  # empty pandas object for history
2707
2708        if interval not in TKS_CANDLE_INTERVALS.keys():
2709            uLogger.error("Interval parameter must be string with current available values: `1min`, `5min`, `15min`, `hour` and `day`.")
2710            raise Exception("Incorrect value")
2711
2712        if not (self._ticker or self._figi):
2713            uLogger.error("Ticker or FIGI must be defined!")
2714            raise Exception("Ticker or FIGI required")
2715
2716        if self._ticker and not self._figi:
2717            instrumentByTicker = self.SearchByTicker(requestPrice=False)
2718            self._figi = instrumentByTicker["figi"] if instrumentByTicker else ""
2719
2720        if self._figi and not self._ticker:
2721            instrumentByFIGI = self.SearchByFIGI(requestPrice=False)
2722            self._ticker = instrumentByFIGI["ticker"] if instrumentByFIGI else ""
2723
2724        dtStart = datetime.strptime(strStartDate, TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc())  # datetime object from start time string
2725        dtEnd = datetime.strptime(strEndDate, TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc())  # datetime object from end time string
2726        if interval.lower() != "day":
2727            dtEnd += timedelta(seconds=1)  # adds 1 sec for requests, because day end returned by `TradeRoutines.GetDatesAsString()` is 23:59:59
2728
2729        delta = dtEnd - dtStart  # current UTC time minus last time in file
2730        deltaMinutes = delta.days * 1440 + delta.seconds // 60  # minutes between start and end dates
2731
2732        # calculate history length in candles:
2733        length = deltaMinutes // TKS_CANDLE_INTERVALS[interval][1]
2734        if deltaMinutes % TKS_CANDLE_INTERVALS[interval][1] > 0:
2735            length += 1  # to avoid fraction time
2736
2737        # calculate data blocks count:
2738        blocks = 1 if length < TKS_CANDLE_INTERVALS[interval][2] else 1 + length // TKS_CANDLE_INTERVALS[interval][2]
2739
2740        uLogger.debug("Original requested time period in local time: from [{}] to [{}]".format(start, end))
2741        uLogger.debug("Requested time period is about from [{}] UTC to [{}] UTC".format(strStartDate, strEndDate))
2742        uLogger.debug("Calculated history length: [{}], interval: [{}]".format(length, interval))
2743        uLogger.debug("Data blocks, count: [{}], max candles in block: [{}]".format(blocks, TKS_CANDLE_INTERVALS[interval][2]))
2744        uLogger.debug("Requesting history candlesticks, ticker: [{}], FIGI: [{}]. Wait, please...".format(self._ticker, self._figi))
2745
2746        tempOld = None  # pandas object for old history, if --only-missing key present
2747        lastTime = None  # datetime object of last old candle in file
2748
2749        if onlyMissing and self.historyFile is not None and self.historyFile and os.path.exists(self.historyFile):
2750            uLogger.debug("--only-missing key present, add only last missing candles...")
2751            uLogger.debug("History file will be updated: [{}]".format(os.path.abspath(self.historyFile)))
2752
2753            tempOld = pd.read_csv(self.historyFile, sep=csvSep, header=None, names=headers)
2754
2755            tempOld["date"] = pd.to_datetime(tempOld["date"])  # load date "as is"
2756            tempOld["date"] = tempOld["date"].dt.strftime("%Y.%m.%d")  # convert date to string
2757            tempOld["time"] = pd.to_datetime(tempOld["time"])  # load time "as is"
2758            tempOld["time"] = tempOld["time"].dt.strftime("%H:%M")  # convert time to string
2759
2760            # get last datetime object from last string in file or minus 1 delta if file is empty:
2761            if len(tempOld) > 0:
2762                lastTime = datetime.strptime(tempOld.date.iloc[-1] + " " + tempOld.time.iloc[-1], "%Y.%m.%d %H:%M").replace(tzinfo=tzutc())
2763
2764            else:
2765                lastTime = dtEnd - timedelta(days=1)  # history file is empty, so last date set at -1 day
2766
2767            tempOld = tempOld[:-1]  # always remove last old candle because it may be incompletely at the current time
2768
2769        responseJSONs = []  # raw history blocks of data
2770
2771        blockEnd = dtEnd
2772        for item in range(blocks):
2773            tail = length % TKS_CANDLE_INTERVALS[interval][2] if item + 1 == blocks else TKS_CANDLE_INTERVALS[interval][2]
2774            blockStart = blockEnd - timedelta(minutes=TKS_CANDLE_INTERVALS[interval][1] * tail)
2775
2776            uLogger.debug("[Block #{}/{}] time period: [{}] UTC - [{}] UTC".format(
2777                item + 1, blocks, blockStart.strftime(TKS_DATE_TIME_FORMAT), blockEnd.strftime(TKS_DATE_TIME_FORMAT),
2778            ))
2779
2780            if blockStart == blockEnd:
2781                uLogger.debug("Skipped this zero-length block...")
2782
2783            else:
2784                # REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/MarketDataService/MarketDataService_GetCandles
2785                historyURL = self.server + r"/tinkoff.public.invest.api.contract.v1.MarketDataService/GetCandles"
2786                self.body = str({
2787                    "figi": self._figi,
2788                    "from": blockStart.strftime(TKS_DATE_TIME_FORMAT),
2789                    "to": blockEnd.strftime(TKS_DATE_TIME_FORMAT),
2790                    "interval": TKS_CANDLE_INTERVALS[interval][0]
2791                })
2792                responseJSON = self.SendAPIRequest(historyURL, reqType="POST", retry=1, pause=1)
2793
2794                if "code" in responseJSON.keys():
2795                    uLogger.debug("An issue occurred and block #{}/{} is empty".format(item + 1, blocks))
2796
2797                else:
2798                    if start is not None and (start.lower() == "yesterday" or start == end) and interval == "day" and len(responseJSON["candles"]) > 1:
2799                        responseJSON["candles"] = responseJSON["candles"][:-1]  # removes last candle for "yesterday" request
2800
2801                    responseJSONs = responseJSON["candles"] + responseJSONs  # add more old history behind newest dates
2802
2803            blockEnd = blockStart
2804
2805        printCount = len(responseJSONs)  # candles to show in console
2806        if responseJSONs:
2807            tempHistory = pd.DataFrame(
2808                data={
2809                    "date": [pd.to_datetime(item["time"]).astimezone(tzutc()) for item in responseJSONs],
2810                    "time": [pd.to_datetime(item["time"]).astimezone(tzutc()) for item in responseJSONs],
2811                    "open": [NanoToFloat(item["open"]["units"], item["open"]["nano"]) for item in responseJSONs],
2812                    "high": [NanoToFloat(item["high"]["units"], item["high"]["nano"]) for item in responseJSONs],
2813                    "low": [NanoToFloat(item["low"]["units"], item["low"]["nano"]) for item in responseJSONs],
2814                    "close": [NanoToFloat(item["close"]["units"], item["close"]["nano"]) for item in responseJSONs],
2815                    "volume": [int(item["volume"]) for item in responseJSONs],
2816                },
2817                index=range(len(responseJSONs)),
2818                columns=["date", "time", "open", "high", "low", "close", "volume"],
2819            )
2820            tempHistory["date"] = tempHistory["date"].dt.strftime("%Y.%m.%d")
2821            tempHistory["time"] = tempHistory["time"].dt.strftime("%H:%M")
2822
2823            # append only newest candles to old history if --only-missing key present:
2824            if onlyMissing and tempOld is not None and lastTime is not None:
2825                index = 0  # find start index in tempHistory data:
2826
2827                for i, item in tempHistory.iterrows():
2828                    curTime = datetime.strptime(item["date"] + " " + item["time"], "%Y.%m.%d %H:%M").replace(tzinfo=tzutc())
2829
2830                    if curTime == lastTime:
2831                        uLogger.debug("History will be updated starting from the date: [{}]".format(curTime.strftime(TKS_PRINT_DATE_TIME_FORMAT)))
2832                        index = i
2833                        printCount = index + 1
2834                        break
2835
2836                history = pd.concat([tempOld, tempHistory[index:]], ignore_index=True)
2837
2838            else:
2839                history = tempHistory  # if no `--only-missing` key then load full data from server
2840
2841            uLogger.debug("Last 3 rows of received history:\n{}".format(pd.DataFrame.to_string(history[["date", "time", "open", "high", "low", "close", "volume"]][-3:], max_cols=20, index=False)))
2842
2843        if history is not None and not history.empty:
2844            if show:
2845                uLogger.info("Here's requested history between [{}] UTC and [{}] UTC, not-empty candles count: [{}]\n{}".format(
2846                    strStartDate.replace("T", " ").replace("Z", ""), strEndDate.replace("T", " ").replace("Z", ""), len(history[-printCount:]),
2847                    pd.DataFrame.to_string(history[["date", "time", "open", "high", "low", "close", "volume"]][-printCount:], max_cols=20, index=False),
2848                ))
2849
2850        else:
2851            uLogger.warning("Received an empty candles history!")
2852
2853        if self.historyFile is not None:
2854            if history is not None and not history.empty:
2855                history.to_csv(self.historyFile, sep=csvSep, index=False, header=None)
2856                uLogger.info("Ticker [{}], FIGI [{}], tf: [{}], history saved: [{}]".format(self._ticker, self._figi, interval, os.path.abspath(self.historyFile)))
2857
2858            else:
2859                uLogger.warning("Empty history received! File NOT updated: [{}]".format(os.path.abspath(self.historyFile)))
2860
2861        else:
2862            uLogger.debug("--output key is not defined. Parsed history file not saved to file, only Pandas DataFrame returns.")
2863
2864        return history
2865
2866    def LoadHistory(self, filePath: str) -> pd.DataFrame:
2867        """
2868        Load candles history from csv-file and return Pandas DataFrame object.
2869
2870        See also: `History()` and `ShowHistoryChart()` methods.
2871
2872        :param filePath: path to csv-file to open.
2873        """
2874        loadedHistory = None  # init candles data object
2875
2876        uLogger.debug("Loading candles history with PriceGenerator module. Wait, please...")
2877
2878        if os.path.exists(filePath):
2879            loadedHistory = self.priceModel.LoadFromFile(filePath)  # load data and get chain of candles as Pandas DataFrame
2880
2881            tfStr = self.priceModel.FormattedDelta(
2882                self.priceModel.timeframe,
2883                "{days} days {hours}h {minutes}m {seconds}s",
2884            ) if self.priceModel.timeframe >= timedelta(days=1) else self.priceModel.FormattedDelta(
2885                self.priceModel.timeframe,
2886                "{hours}h {minutes}m {seconds}s",
2887            )
2888
2889            if loadedHistory is not None and not loadedHistory.empty:
2890                uLogger.info("Rows count loaded: [{}], detected timeframe of candles: [{}]. Showing some last rows:\n{}".format(
2891                    len(loadedHistory),
2892                    tfStr,
2893                    pd.DataFrame.to_string(loadedHistory[-10:], max_cols=20)),
2894                )
2895
2896            else:
2897                uLogger.warning("It was loaded an empty history! Path: [{}]".format(os.path.abspath(filePath)))
2898
2899        else:
2900            uLogger.error("File with candles history does not exist! Check the path: [{}]".format(filePath))
2901
2902        return loadedHistory
2903
2904    def ShowHistoryChart(self, candles: Union[str, pd.DataFrame] = None, interact: bool = True, openInBrowser: bool = False) -> None:
2905        """
2906        Render an HTML-file with interact or non-interact candlesticks chart. Candles may be path to the csv-file.
2907
2908        Self variable `htmlHistoryFile` can be use as html-file name to save interaction or non-interaction chart.
2909        Default: `index.html` (both for interact and non-interact candlesticks chart).
2910
2911        See also: `History()` and `LoadHistory()` methods.
2912
2913        :param candles: string to csv-file with candles in OHLCV-model or like Pandas Dataframe object.
2914        :param interact: if True (default) then chain of candlesticks will render as interactive Bokeh chart.
2915                         See examples: https://github.com/Tim55667757/PriceGenerator#overriding-parameters
2916                         If False then chain of candlesticks will render as not interactive Google Candlestick chart.
2917                         See examples: https://github.com/Tim55667757/PriceGenerator#statistics-and-chart-on-a-simple-template
2918        :param openInBrowser: if True then immediately open chart in default browser, otherwise only path to
2919                              html-file prints to console. False by default, to avoid issues with `permissions denied` to html-file.
2920        """
2921        if isinstance(candles, str):
2922            self.priceModel.prices = self.LoadHistory(filePath=candles)  # load candles chain from file
2923            self.priceModel.ticker = os.path.basename(candles)  # use filename as ticker name in PriceGenerator
2924
2925        elif isinstance(candles, pd.DataFrame):
2926            self.priceModel.prices = candles  # set candles chain from variable
2927            self.priceModel.ticker = self._ticker  # use current TKSBrokerAPI ticker as ticker name in PriceGenerator
2928
2929            if "datetime" not in candles.columns:
2930                self.priceModel.prices["datetime"] = pd.to_datetime(candles.date + ' ' + candles.time, utc=True)  # PriceGenerator uses "datetime" column with date and time
2931
2932        else:
2933            uLogger.error("`candles` variable must be path string to the csv-file with candles in OHLCV-model or like Pandas Dataframe object!")
2934            raise Exception("Incorrect value")
2935
2936        self.priceModel.horizon = len(self.priceModel.prices)  # use length of candles data as horizon in PriceGenerator
2937
2938        if interact:
2939            uLogger.debug("Rendering interactive candles chart. Wait, please...")
2940
2941            self.priceModel.RenderBokeh(fileName=self.htmlHistoryFile, viewInBrowser=openInBrowser)
2942
2943        else:
2944            uLogger.debug("Rendering non-interactive candles chart. Wait, please...")
2945
2946            self.priceModel.RenderGoogle(fileName=self.htmlHistoryFile, viewInBrowser=openInBrowser)
2947
2948        uLogger.info("Rendered candles chart: [{}]".format(os.path.abspath(self.htmlHistoryFile)))
2949
2950    def Trade(self, operation: str, lots: int = 1, tp: float = 0., sl: float = 0., expDate: str = "Undefined") -> dict:
2951        """
2952        Universal method to create market order and make deal at the current price for current `accountId`. Returns JSON data with response.
2953        If `tp` or `sl` > 0, then in additional will open stop-orders with "TP" and "SL" flags for `stopType` parameter.
2954
2955        See also: `Order()` docstring. More simple methods than `Trade()` are `Buy()` and `Sell()`.
2956
2957        :param operation: string "Buy" or "Sell".
2958        :param lots: volume, integer count of lots >= 1.
2959        :param tp: float > 0, target price for stop-order with "TP" type. It used as take profit parameter `targetPrice` in `self.Order()`.
2960        :param sl: float > 0, target price for stop-order with "SL" type. It used as stop loss parameter `targetPrice` in `self.Order()`.
2961        :param expDate: string "Undefined" by default or local date in future,
2962                        it is a string with format `%Y-%m-%d %H:%M:%S`.
2963        :return: JSON with response from broker server.
2964        """
2965        if self.accountId is None or not self.accountId:
2966            uLogger.error("Variable `accountId` must be defined for using this method!")
2967            raise Exception("Account ID required")
2968
2969        if operation is None or not operation or operation not in ("Buy", "Sell"):
2970            uLogger.error("You must define operation type only one of them: `Buy` or `Sell`!")
2971            raise Exception("Incorrect value")
2972
2973        if lots is None or lots < 1:
2974            uLogger.warning("You must define trade volume > 0: integer count of lots! For current operation lots reset to 1.")
2975            lots = 1
2976
2977        if tp is None or tp < 0:
2978            tp = 0
2979
2980        if sl is None or sl < 0:
2981            sl = 0
2982
2983        if expDate is None or not expDate:
2984            expDate = "Undefined"
2985
2986        if not (self._ticker or self._figi):
2987            uLogger.error("Ticker or FIGI must be defined!")
2988            raise Exception("Ticker or FIGI required")
2989
2990        instrument = self.SearchByTicker(requestPrice=True) if self._ticker else self.SearchByFIGI(requestPrice=True)
2991        self._ticker = instrument["ticker"]
2992        self._figi = instrument["figi"]
2993
2994        uLogger.debug("Opening [{}] market order: ticker [{}], FIGI [{}], lots [{}], TP [{:.4f}], SL [{:.4f}], expiration date of TP/SL orders [{}]. Wait, please...".format(operation, self._ticker, self._figi, lots, tp, sl, expDate))
2995
2996        openTradeURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OrdersService/PostOrder"
2997        self.body = str({
2998            "figi": self._figi,
2999            "quantity": str(lots),
3000            "direction": "ORDER_DIRECTION_BUY" if operation == "Buy" else "ORDER_DIRECTION_SELL",  # see: TKS_ORDER_DIRECTIONS
3001            "accountId": str(self.accountId),
3002            "orderType": "ORDER_TYPE_MARKET",  # see: TKS_ORDER_TYPES
3003        })
3004        response = self.SendAPIRequest(openTradeURL, reqType="POST", retry=0)
3005
3006        if "orderId" in response.keys():
3007            uLogger.info("[{}] market order [{}] was executed: ticker [{}], FIGI [{}], lots [{}]. Total order price: [{:.4f} {}] (with commission: [{:.2f} {}]). Average price of lot: [{:.2f} {}]".format(
3008                operation, response["orderId"],
3009                self._ticker, self._figi, lots,
3010                NanoToFloat(response["totalOrderAmount"]["units"], response["totalOrderAmount"]["nano"]), response["totalOrderAmount"]["currency"],
3011                NanoToFloat(response["initialCommission"]["units"], response["initialCommission"]["nano"]), response["initialCommission"]["currency"],
3012                NanoToFloat(response["executedOrderPrice"]["units"], response["executedOrderPrice"]["nano"]), response["executedOrderPrice"]["currency"],
3013            ))
3014
3015            if tp > 0:
3016                self.Order(operation="Sell" if operation == "Buy" else "Buy", orderType="Stop", lots=lots, targetPrice=tp, limitPrice=tp, stopType="TP", expDate=expDate)
3017
3018            if sl > 0:
3019                self.Order(operation="Sell" if operation == "Buy" else "Buy", orderType="Stop", lots=lots, targetPrice=sl, limitPrice=sl, stopType="SL", expDate=expDate)
3020
3021        else:
3022            uLogger.warning("Not `oK` status received! Market order not executed. See full debug log and try again open order later.")
3023
3024        return response
3025
3026    def Buy(self, lots: int = 1, tp: float = 0., sl: float = 0., expDate: str = "Undefined") -> dict:
3027        """
3028        More simple method than `Trade()`. Create `Buy` market order and make deal at the current price. Returns JSON data with response.
3029        If `tp` or `sl` > 0, then in additional will opens stop-orders with "TP" and "SL" flags for `stopType` parameter.
3030
3031        See also: `Order()` and `Trade()` docstrings.
3032
3033        :param lots: volume, integer count of lots >= 1.
3034        :param tp: float > 0, take profit price of stop-order.
3035        :param sl: float > 0, stop loss price of stop-order.
3036        :param expDate: it's a local date in future.
3037                        String has a format like this: `%Y-%m-%d %H:%M:%S`.
3038        :return: JSON with response from broker server.
3039        """
3040        return self.Trade(operation="Buy", lots=lots, tp=tp, sl=sl, expDate=expDate)
3041
3042    def Sell(self, lots: int = 1, tp: float = 0., sl: float = 0., expDate: str = "Undefined") -> dict:
3043        """
3044        More simple method than `Trade()`. Create `Sell` market order and make deal at the current price. Returns JSON data with response.
3045        If `tp` or `sl` > 0, then in additional will open stop-orders with "TP" and "SL" flags for `stopType` parameter.
3046
3047        See also: `Order()` and `Trade()` docstrings.
3048
3049        :param lots: volume, integer count of lots >= 1.
3050        :param tp: float > 0, take profit price of stop-order.
3051        :param sl: float > 0, stop loss price of stop-order.
3052        :param expDate: it's a local date in the future.
3053                        String has a format like this: `%Y-%m-%d %H:%M:%S`.
3054        :return: JSON with response from broker server.
3055        """
3056        return self.Trade(operation="Sell", lots=lots, tp=tp, sl=sl, expDate=expDate)
3057
3058    def CloseTrades(self, instruments: list[str], portfolio: dict = None) -> None:
3059        """
3060        Close position of given instruments.
3061
3062        :param instruments: list of instruments defined by tickers or FIGIs that must be closed.
3063        :param portfolio: pre-received dictionary with open trades, returned by `Overview()` method.
3064                         This avoids unnecessary downloading data from the server.
3065        """
3066        if instruments is None or not instruments:
3067            uLogger.error("List of tickers or FIGIs must be defined for using this method!")
3068            raise Exception("Ticker or FIGI required")
3069
3070        if isinstance(instruments, str):
3071            instruments = [instruments]
3072
3073        uniqueInstruments = self.GetUniqueFIGIs(instruments)
3074        if uniqueInstruments:
3075            if portfolio is None or not portfolio:
3076                portfolio = self.Overview(show=False)
3077
3078            allOpened = [item["figi"] for iType in TKS_INSTRUMENTS for item in portfolio["stat"][iType]]
3079            uLogger.debug("All opened instruments by it's FIGI: {}".format(", ".join(allOpened)))
3080
3081            for self._figi in uniqueInstruments:
3082                if self._figi not in allOpened:
3083                    uLogger.warning("Instrument with FIGI [{}] not in open positions list!".format(self._figi))
3084                    continue
3085
3086                # search open trade info about instrument by ticker:
3087                instrument = {}
3088                for iType in TKS_INSTRUMENTS:
3089                    if instrument:
3090                        break
3091
3092                    for item in portfolio["stat"][iType]:
3093                        if item["figi"] == self._figi:
3094                            instrument = item
3095                            break
3096
3097                if instrument:
3098                    self._ticker = instrument["ticker"]
3099                    self._figi = instrument["figi"]
3100
3101                    uLogger.debug("Closing trade of instrument: ticker [{}], FIGI[{}], lots [{}]{}. Wait, please...".format(
3102                        self._ticker,
3103                        self._figi,
3104                        int(instrument["volume"]),
3105                        ", blocked [{}]".format(instrument["blocked"]) if instrument["blocked"] > 0 else "",
3106                    ))
3107
3108                    tradeLots = abs(instrument["lots"]) - instrument["blocked"]  # available volumes in lots for close operation
3109
3110                    if tradeLots > 0:
3111                        if instrument["blocked"] > 0:
3112                            uLogger.warning("Just for your information: there are [{}] lots blocked for instrument [{}]! Available only [{}] lots to closing trade.".format(
3113                                instrument["blocked"],
3114                                self._ticker,
3115                                tradeLots,
3116                            ))
3117
3118                        # if direction is "Long" then we need sell, if direction is "Short" then we need buy:
3119                        self.Trade(operation="Sell" if instrument["direction"] == "Long" else "Buy", lots=tradeLots)
3120
3121                    else:
3122                        uLogger.warning("There are no available lots for instrument [{}] to closing trade at this moment! Try again later or cancel some orders.".format(self._ticker))
3123
3124    def CloseAllTrades(self, iType: str, portfolio: dict = None) -> None:
3125        """
3126        Close all positions of given instruments with defined type.
3127
3128        :param iType: type of the instruments that be closed, it must be one of supported types in TKS_INSTRUMENTS list.
3129        :param portfolio: pre-received dictionary with open trades, returned by `Overview()` method.
3130                         This avoids unnecessary downloading data from the server.
3131        """
3132        if iType not in TKS_INSTRUMENTS:
3133            uLogger.warning("Type of the instrument must be one of supported types: {}. Given: [{}]".format(", ".join(TKS_INSTRUMENTS), iType))
3134
3135        else:
3136            if portfolio is None or not portfolio:
3137                portfolio = self.Overview(show=False)
3138
3139            tickers = [item["ticker"] for item in portfolio["stat"][iType]]
3140            uLogger.debug("Instrument tickers with type [{}] that will be closed: {}".format(iType, tickers))
3141
3142            if tickers and portfolio:
3143                self.CloseTrades(tickers, portfolio)
3144
3145            else:
3146                uLogger.info("Instrument tickers with type [{}] not found, nothing to close.".format(iType))
3147
3148    def Order(self, operation: str, orderType: str, lots: int, targetPrice: float, limitPrice: float = 0., stopType: str = "Limit", expDate: str = "Undefined") -> dict:
3149        """
3150        Universal method to create market or limit orders with all available parameters for current `accountId`.
3151        See more simple methods: `BuyLimit()`, `BuyStop()`, `SellLimit()`, `SellStop()`.
3152
3153        If orderType is "Limit" then create pending limit-order below current price if operation is "Buy" and above
3154        current price if operation is "Sell". A limit order has no expiration date, it lasts until the end of the trading day.
3155
3156        Warning! If you try to create limit-order above current price if "Buy" or below current price if "Sell"
3157        then broker immediately open market order as you can do simple --buy or --sell operations!
3158
3159        If orderType is "Stop" then creates stop-order with any direction "Buy" or "Sell".
3160        When current price will go up or down to target price value then broker opens a limit order.
3161        Stop-order is opened with unlimited expiration date by default, or you can define expiration date with expDate parameter.
3162
3163        Only one attempt and no retry for opens order. If network issue occurred you can create new request.
3164
3165        :param operation: string "Buy" or "Sell".
3166        :param orderType: string "Limit" or "Stop".
3167        :param lots: volume, integer count of lots >= 1.
3168        :param targetPrice: target price > 0. This is open trade price for limit order.
3169        :param limitPrice: limit price >= 0. This parameter only makes sense for stop-order. If limitPrice = 0, then it set as targetPrice.
3170                           Broker will creates limit-order with price equal to limitPrice, when current price goes to target price of stop-order.
3171        :param stopType: string "Limit" by default. This parameter only makes sense for stop-order. There are 3 stop-order types
3172                         "SL", "TP", "Limit" for "Stop loss", "Take profit" and "Stop limit" types accordingly.
3173                         Stop loss order always executed by market price.
3174        :param expDate: string "Undefined" by default or local date in future.
3175                        String has a format like this: `%Y-%m-%d %H:%M:%S`.
3176                        This date is converting to UTC format for server. This parameter only makes sense for stop-order.
3177                        A limit order has no expiration date, it lasts until the end of the trading day.
3178        :return: JSON with response from broker server.
3179        """
3180        if self.accountId is None or not self.accountId:
3181            uLogger.error("Variable `accountId` must be defined for using this method!")
3182            raise Exception("Account ID required")
3183
3184        if operation is None or not operation or operation not in ("Buy", "Sell"):
3185            uLogger.error("You must define operation type only one of them: `Buy` or `Sell`!")
3186            raise Exception("Incorrect value")
3187
3188        if orderType is None or not orderType or orderType not in ("Limit", "Stop"):
3189            uLogger.error("You must define order type only one of them: `Limit` or `Stop`!")
3190            raise Exception("Incorrect value")
3191
3192        if lots is None or lots < 1:
3193            uLogger.error("You must define trade volume > 0: integer count of lots!")
3194            raise Exception("Incorrect value")
3195
3196        if targetPrice is None or targetPrice <= 0:
3197            uLogger.error("Target price for limit-order must be greater than 0!")
3198            raise Exception("Incorrect value")
3199
3200        if limitPrice is None or limitPrice <= 0:
3201            limitPrice = targetPrice
3202
3203        if stopType is None or not stopType or stopType not in ("SL", "TP", "Limit"):
3204            stopType = "Limit"
3205
3206        if expDate is None or not expDate:
3207            expDate = "Undefined"
3208
3209        if not (self._ticker or self._figi):
3210            uLogger.error("Tocker or FIGI must be defined!")
3211            raise Exception("Ticker or FIGI required")
3212
3213        response = {}
3214        instrument = self.SearchByTicker(requestPrice=True) if self._ticker else self.SearchByFIGI(requestPrice=True)
3215        self._ticker = instrument["ticker"]
3216        self._figi = instrument["figi"]
3217
3218        if orderType == "Limit":
3219            uLogger.debug(
3220                "Creating pending limit-order: ticker [{}], FIGI [{}], action [{}], lots [{}] and the target price [{:.2f} {}]. Wait, please...".format(
3221                    self._ticker, self._figi,
3222                    operation, lots, targetPrice, instrument["currency"],
3223                ))
3224
3225            openOrderURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OrdersService/PostOrder"
3226            self.body = str({
3227                "figi": self._figi,
3228                "quantity": str(lots),
3229                "price": FloatToNano(targetPrice),
3230                "direction": "ORDER_DIRECTION_BUY" if operation == "Buy" else "ORDER_DIRECTION_SELL",  # see: TKS_ORDER_DIRECTIONS
3231                "accountId": str(self.accountId),
3232                "orderType": "ORDER_TYPE_LIMIT",  # see: TKS_ORDER_TYPES
3233            })
3234            response = self.SendAPIRequest(openOrderURL, reqType="POST", retry=0)
3235
3236            if "orderId" in response.keys():
3237                uLogger.info(
3238                    "Limit-order [{}] was created: ticker [{}], FIGI [{}], action [{}], lots [{}], target price [{} {}]".format(
3239                        response["orderId"], self._ticker, self._figi, operation, lots,
3240                        "{:.4f}".format(targetPrice).rstrip("0").rstrip("."), instrument["currency"],
3241                    ))
3242
3243                if "lastPrice" in instrument["currentPrice"].keys() and instrument["currentPrice"]["lastPrice"]:
3244                    if operation == "Buy" and targetPrice > instrument["currentPrice"]["lastPrice"]:
3245                        uLogger.warning("Your order was executed as a market order, not as a limit order! Comment: because your target price [{:.2f} {}] was higher than current price [{:.2f} {}] broker immediately opened `Buy` market order, such as if you did simple `--buy` operation.".format(
3246                            targetPrice, instrument["currency"],
3247                            instrument["currentPrice"]["lastPrice"], instrument["currency"],
3248                        ))
3249
3250                    if operation == "Sell" and targetPrice < instrument["currentPrice"]["lastPrice"]:
3251                        uLogger.warning("Your order was executed as a market order, not as a limit order! Comment: because your target price [{:.2f} {}] was lower than current price [{:.2f} {}] broker immediately opened `Sell` market order, such as if you did simple `--sell` operation.".format(
3252                            targetPrice, instrument["currency"],
3253                            instrument["currentPrice"]["lastPrice"], instrument["currency"],
3254                        ))
3255
3256            else:
3257                uLogger.warning("Not `oK` status received! Limit order not opened. See full debug log and try again open order later.")
3258
3259        if orderType == "Stop":
3260            uLogger.debug(
3261                "Creating stop-order: ticker [{}], FIGI [{}], action [{}], lots [{}], target price [{:.2f} {}], limit price [{:.2f} {}], stop-order type [{}] and local expiration date [{}]. Wait, please...".format(
3262                    self._ticker, self._figi,
3263                    operation, lots,
3264                    targetPrice, instrument["currency"],
3265                    limitPrice, instrument["currency"],
3266                    stopType, expDate,
3267                ))
3268
3269            openOrderURL = self.server + r"/tinkoff.public.invest.api.contract.v1.StopOrdersService/PostStopOrder"
3270            expDateUTC = "" if expDate == "Undefined" else datetime.strptime(expDate, TKS_PRINT_DATE_TIME_FORMAT).replace(tzinfo=tzlocal()).astimezone(tzutc()).strftime(TKS_DATE_TIME_FORMAT_EXT)
3271            stopOrderType = "STOP_ORDER_TYPE_STOP_LOSS" if stopType == "SL" else "STOP_ORDER_TYPE_TAKE_PROFIT" if stopType == "TP" else "STOP_ORDER_TYPE_STOP_LIMIT"
3272
3273            body = {
3274                "figi": self._figi,
3275                "quantity": str(lots),
3276                "price": FloatToNano(limitPrice),
3277                "stopPrice": FloatToNano(targetPrice),
3278                "direction": "STOP_ORDER_DIRECTION_BUY" if operation == "Buy" else "STOP_ORDER_DIRECTION_SELL",  # see: TKS_STOP_ORDER_DIRECTIONS
3279                "accountId": str(self.accountId),
3280                "expirationType": "STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_DATE" if expDateUTC else "STOP_ORDER_EXPIRATION_TYPE_GOOD_TILL_CANCEL",  # see: TKS_STOP_ORDER_EXPIRATION_TYPES
3281                "stopOrderType": stopOrderType,  # see: TKS_STOP_ORDER_TYPES
3282            }
3283
3284            if expDateUTC:
3285                body["expireDate"] = expDateUTC
3286
3287            self.body = str(body)
3288            response = self.SendAPIRequest(openOrderURL, reqType="POST", retry=0)
3289
3290            if "stopOrderId" in response.keys():
3291                uLogger.info(
3292                    "Stop-order [{}] was created: ticker [{}], FIGI [{}], action [{}], lots [{}], target price [{} {}], limit price [{} {}], stop-order type [{}] and expiration date [{} UTC]".format(
3293                        response["stopOrderId"], self._ticker, self._figi, operation, lots,
3294                        "{:.4f}".format(targetPrice).rstrip("0").rstrip("."), instrument["currency"],
3295                        "{:.4f}".format(limitPrice).rstrip("0").rstrip("."), instrument["currency"],
3296                        TKS_STOP_ORDER_TYPES[stopOrderType],
3297                        datetime.strptime(expDateUTC, TKS_DATE_TIME_FORMAT_EXT).replace(tzinfo=tzutc()).astimezone(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT) if expDateUTC else TKS_STOP_ORDER_EXPIRATION_TYPES["STOP_ORDER_EXPIRATION_TYPE_UNSPECIFIED"],
3298                    ))
3299
3300                if "lastPrice" in instrument["currentPrice"].keys() and instrument["currentPrice"]["lastPrice"]:
3301                    if operation == "Buy" and targetPrice < instrument["currentPrice"]["lastPrice"] and stopType != "TP":
3302                        uLogger.warning("The broker will cancel this order after some time. Comment: you placed the wrong stop order because the target buy price [{:.2f} {}] is lower than the current price [{:.2f} {}]. Also try to set up order type as `TP` if you want to place stop order at that price.".format(
3303                            targetPrice, instrument["currency"],
3304                            instrument["currentPrice"]["lastPrice"], instrument["currency"],
3305                        ))
3306
3307                    if operation == "Sell" and targetPrice > instrument["currentPrice"]["lastPrice"] and stopType != "TP":
3308                        uLogger.warning("The broker will cancel this order after some time. Comment: you placed the wrong stop order because the target sell price [{:.2f} {}] is higher than the current price [{:.2f} {}]. Also try to set up order type as `TP` if you want to place stop order at that price.".format(
3309                            targetPrice, instrument["currency"],
3310                            instrument["currentPrice"]["lastPrice"], instrument["currency"],
3311                        ))
3312
3313            else:
3314                uLogger.warning("Not `oK` status received! Stop order not opened. See full debug log and try again open order later.")
3315
3316        return response
3317
3318    def BuyLimit(self, lots: int, targetPrice: float) -> dict:
3319        """
3320        Create pending `Buy` limit-order (below current price). You must specify only 2 parameters:
3321        `lots` and `target price` to open buy limit-order. If you try to create buy limit-order above current price then
3322        broker immediately open `Buy` market order, such as if you do simple `--buy` operation!
3323        See also: `Order()` docstring.
3324
3325        :param lots: volume, integer count of lots >= 1.
3326        :param targetPrice: target price > 0. This is open trade price for limit order.
3327        :return: JSON with response from broker server.
3328        """
3329        return self.Order(operation="Buy", orderType="Limit", lots=lots, targetPrice=targetPrice)
3330
3331    def BuyStop(self, lots: int, targetPrice: float, limitPrice: float = 0., stopType: str = "Limit", expDate: str = "Undefined") -> dict:
3332        """
3333        Create `Buy` stop-order. You must specify at least 2 parameters: `lots` `target price` to open buy stop-order.
3334        In additional you can specify 3 parameters for buy stop-order: `limit price` >=0, `stop type` = Limit|SL|TP,
3335        `expiration date` = Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`. When current price will go up or down to
3336        target price value then broker opens a limit order. See also: `Order()` docstring.
3337
3338        :param lots: volume, integer count of lots >= 1.
3339        :param targetPrice: target price > 0. This is trigger price for buy stop-order.
3340        :param limitPrice: limit price >= 0 (limitPrice = targetPrice if limitPrice is 0). Broker will creates limit-order
3341                           with price equal to limitPrice, when current price goes to target price of buy stop-order.
3342        :param stopType: string "Limit" by default. There are 3 stop-order types "SL", "TP", "Limit"
3343                         for "Stop loss", "Take profit" and "Stop limit" types accordingly.
3344        :param expDate: string "Undefined" by default or local date in future.
3345                        String has a format like this: `%Y-%m-%d %H:%M:%S`.
3346                        This date is converting to UTC format for server.
3347        :return: JSON with response from broker server.
3348        """
3349        return self.Order(operation="Buy", orderType="Stop", lots=lots, targetPrice=targetPrice, limitPrice=limitPrice, stopType=stopType, expDate=expDate)
3350
3351    def SellLimit(self, lots: int, targetPrice: float) -> dict:
3352        """
3353        Create pending `Sell` limit-order (above current price). You must specify only 2 parameters:
3354        `lots` and `target price` to open sell limit-order. If you try to create sell limit-order below current price then
3355        broker immediately open `Sell` market order, such as if you do simple `--sell` operation!
3356        See also: `Order()` docstring.
3357
3358        :param lots: volume, integer count of lots >= 1.
3359        :param targetPrice: target price > 0. This is open trade price for limit order.
3360        :return: JSON with response from broker server.
3361        """
3362        return self.Order(operation="Sell", orderType="Limit", lots=lots, targetPrice=targetPrice)
3363
3364    def SellStop(self, lots: int, targetPrice: float, limitPrice: float = 0., stopType: str = "Limit", expDate: str = "Undefined") -> dict:
3365        """
3366        Create `Sell` stop-order. You must specify at least 2 parameters: `lots` `target price` to open sell stop-order.
3367        In additional you can specify 3 parameters for sell stop-order: `limit price` >=0, `stop type` = Limit|SL|TP,
3368        `expiration date` = Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`. When current price will go up or down to
3369        target price value then broker opens a limit order. See also: `Order()` docstring.
3370
3371        :param lots: volume, integer count of lots >= 1.
3372        :param targetPrice: target price > 0. This is trigger price for sell stop-order.
3373        :param limitPrice: limit price >= 0 (limitPrice = targetPrice if limitPrice is 0). Broker will creates limit-order
3374                           with price equal to limitPrice, when current price goes to target price of sell stop-order.
3375        :param stopType: string "Limit" by default. There are 3 stop-order types "SL", "TP", "Limit"
3376                         for "Stop loss", "Take profit" and "Stop limit" types accordingly.
3377        :param expDate: string "Undefined" by default or local date in future.
3378                        String has a format like this: `%Y-%m-%d %H:%M:%S`.
3379                        This date is converting to UTC format for server.
3380        :return: JSON with response from broker server.
3381        """
3382        return self.Order(operation="Sell", orderType="Stop", lots=lots, targetPrice=targetPrice, limitPrice=limitPrice, stopType=stopType, expDate=expDate)
3383
3384    def CloseOrders(self, orderIDs: list, allOrdersIDs: list = None, allStopOrdersIDs: list = None) -> None:
3385        """
3386        Cancel order or list of orders by its `orderId` or `stopOrderId` for current `accountId`.
3387
3388        :param orderIDs: list of integers with `orderId` or `stopOrderId`.
3389        :param allOrdersIDs: pre-received lists of all active pending limit orders.
3390                             This avoids unnecessary downloading data from the server.
3391        :param allStopOrdersIDs: pre-received lists of all active stop orders.
3392        """
3393        if self.accountId is None or not self.accountId:
3394            uLogger.error("Variable `accountId` must be defined for using this method!")
3395            raise Exception("Account ID required")
3396
3397        if orderIDs:
3398            if allOrdersIDs is None:
3399                rawOrders = self.RequestPendingOrders()
3400                allOrdersIDs = [item["orderId"] for item in rawOrders]  # all pending limit orders ID
3401
3402            if allStopOrdersIDs is None:
3403                rawStopOrders = self.RequestStopOrders()
3404                allStopOrdersIDs = [item["stopOrderId"] for item in rawStopOrders]  # all stop orders ID
3405
3406            for orderID in orderIDs:
3407                idInPendingOrders = orderID in allOrdersIDs
3408                idInStopOrders = orderID in allStopOrdersIDs
3409
3410                if not (idInPendingOrders or idInStopOrders):
3411                    uLogger.warning("Order not found by ID: [{}]. Maybe cancelled already? Check it with `--overview` key.".format(orderID))
3412                    continue
3413
3414                else:
3415                    if idInPendingOrders:
3416                        uLogger.debug("Cancelling pending order with ID: [{}]. Wait, please...".format(orderID))
3417
3418                        # REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/OrdersService/OrdersService_CancelOrder
3419                        self.body = str({"accountId": self.accountId, "orderId": orderID})
3420                        closeURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OrdersService/CancelOrder"
3421                        responseJSON = self.SendAPIRequest(closeURL, reqType="POST")
3422
3423                        if responseJSON and "time" in responseJSON.keys() and responseJSON["time"]:
3424                            if self.moreDebug:
3425                                uLogger.debug("Success time marker received from server: [{}] (UTC)".format(responseJSON["time"]))
3426
3427                            uLogger.info("Pending order with ID [{}] successfully cancel".format(orderID))
3428
3429                        else:
3430                            uLogger.warning("Unknown issue occurred when cancelling pending order with ID: [{}]. Check ID and try again.".format(orderID))
3431
3432                    elif idInStopOrders:
3433                        uLogger.debug("Cancelling stop order with ID: [{}]. Wait, please...".format(orderID))
3434
3435                        # REST API for request: https://tinkoff.github.io/investAPI/swagger-ui/#/StopOrdersService/StopOrdersService_CancelStopOrder
3436                        self.body = str({"accountId": self.accountId, "stopOrderId": orderID})
3437                        closeURL = self.server + r"/tinkoff.public.invest.api.contract.v1.StopOrdersService/CancelStopOrder"
3438                        responseJSON = self.SendAPIRequest(closeURL, reqType="POST")
3439
3440                        if responseJSON and "time" in responseJSON.keys() and responseJSON["time"]:
3441                            if self.moreDebug:
3442                                uLogger.debug("Success time marker received from server: [{}] (UTC)".format(responseJSON["time"]))
3443
3444                            uLogger.info("Stop order with ID [{}] successfully cancel".format(orderID))
3445
3446                        else:
3447                            uLogger.warning("Unknown issue occurred when cancelling stop order with ID: [{}]. Check ID and try again.".format(orderID))
3448
3449                    else:
3450                        continue
3451
3452    def CloseAllOrders(self) -> None:
3453        """
3454        Gets a list of open pending and stop orders and cancel it all.
3455        """
3456        rawOrders = self.RequestPendingOrders()
3457        allOrdersIDs = [item["orderId"] for item in rawOrders]  # all pending limit orders ID
3458        lenOrders = len(allOrdersIDs)
3459
3460        rawStopOrders = self.RequestStopOrders()
3461        allStopOrdersIDs = [item["stopOrderId"] for item in rawStopOrders]  # all stop orders ID
3462        lenSOrders = len(allStopOrdersIDs)
3463
3464        if lenOrders > 0 or lenSOrders > 0:
3465            uLogger.info("Found: [{}] opened pending and [{}] stop orders. Let's trying to cancel it all. Wait, please...".format(lenOrders, lenSOrders))
3466
3467            self.CloseOrders(allOrdersIDs + allStopOrdersIDs, allOrdersIDs, allStopOrdersIDs)
3468
3469        else:
3470            uLogger.info("Orders not found, nothing to cancel.")
3471
3472    def CloseAll(self, *args) -> None:
3473        """
3474        Close all available (not blocked) opened trades and orders.
3475
3476        Also, you can select one or more keywords case-insensitive:
3477        `orders`, `shares`, `bonds`, `etfs` and `futures` from `TKS_INSTRUMENTS` enum to specify trades type.
3478
3479        Currency positions you must close manually using buy or sell operations, `CloseTrades()` or `CloseAllTrades()` methods.
3480        """
3481        overview = self.Overview(show=False)  # get all open trades info
3482
3483        if len(args) == 0:
3484            uLogger.debug("Closing all available (not blocked) opened trades and orders. Currency positions you must closes manually using buy or sell operations! Wait, please...")
3485            self.CloseAllOrders()  # close all pending and stop orders
3486
3487            for iType in TKS_INSTRUMENTS:
3488                if iType != "Currencies":
3489                    self.CloseAllTrades(iType, overview)  # close all positions of instruments with same type without currencies
3490
3491        else:
3492            uLogger.debug("Closing all available {}. Currency positions you must closes manually using buy or sell operations! Wait, please...".format(list(args)))
3493            lowerArgs = [x.lower() for x in args]
3494
3495            if "orders" in lowerArgs:
3496                self.CloseAllOrders()  # close all pending and stop orders
3497
3498            for iType in TKS_INSTRUMENTS:
3499                if iType.lower() in lowerArgs and iType != "Currencies":
3500                    self.CloseAllTrades(iType, overview)  # close all positions of instruments with same type without currencies
3501
3502    def CloseAllByTicker(self, instrument: str) -> None:
3503        """
3504        Close all available (not blocked) opened trades and orders for one instrument defined by its ticker.
3505
3506        This method searches opened trade and orders of instrument throw all portfolio and then use
3507        `CloseTrades()` and `CloseOrders()` methods to close trade and cancel all orders for that instrument.
3508
3509        See also: `IsInLimitOrders()`, `GetLimitOrderIDs()`, `IsInStopOrders()`, `GetStopOrderIDs()`, `CloseTrades()` and `CloseOrders()`.
3510
3511        :param instrument: string with ticker.
3512        """
3513        if instrument is None or not instrument:
3514            uLogger.error("Ticker name must be defined for using this method!")
3515            raise Exception("Ticker required")
3516
3517        overview = self.Overview(show=False)  # get user portfolio with all open trades info
3518
3519        self._ticker = instrument  # try to set instrument as ticker
3520        self._figi = ""
3521
3522        limitAll = [item["orderID"] for item in overview["stat"]["orders"]]  # list of all pending limit order IDs
3523        stopAll = [item["orderID"] for item in overview["stat"]["stopOrders"]]  # list of all stop order IDs
3524
3525        if limitAll and self.IsInLimitOrders(portfolio=overview):
3526            uLogger.debug("Closing all opened pending limit orders for the instrument with ticker [{}]. Wait, please...")
3527            self.CloseOrders(orderIDs=self.GetLimitOrderIDs(portfolio=overview), allOrdersIDs=limitAll, allStopOrdersIDs=stopAll)
3528
3529        if stopAll and self.IsInStopOrders(portfolio=overview):
3530            uLogger.debug("Closing all opened stop orders for the instrument with ticker [{}]. Wait, please...")
3531            self.CloseOrders(orderIDs=self.GetStopOrderIDs(portfolio=overview), allOrdersIDs=limitAll, allStopOrdersIDs=stopAll)
3532
3533        if self.IsInPortfolio(portfolio=overview):
3534            uLogger.debug("Closing all available (not blocked) opened trade for the instrument with ticker [{}]. Wait, please...")
3535            self.CloseTrades(instruments=[instrument], portfolio=overview)
3536
3537    def CloseAllByFIGI(self, instrument: str) -> None:
3538        """
3539        Close all available (not blocked) opened trades and orders for one instrument defined by its FIGI id.
3540
3541        This method searches opened trade and orders of instrument throw all portfolio and then use
3542        `CloseTrades()` and `CloseOrders()` methods to close trade and cancel all orders for that instrument.
3543
3544        See also: `IsInLimitOrders()`, `GetLimitOrderIDs()`, `IsInStopOrders()`, `GetStopOrderIDs()`, `CloseTrades()` and `CloseOrders()`.
3545
3546        :param instrument: string with FIGI id.
3547        """
3548        if instrument is None or not instrument:
3549            uLogger.error("FIGI id must be defined for using this method!")
3550            raise Exception("FIGI required")
3551
3552        overview = self.Overview(show=False)  # get user portfolio with all open trades info
3553
3554        self._ticker = ""
3555        self._figi = instrument  # try to set instrument as FIGI id
3556
3557        limitAll = [item["orderID"] for item in overview["stat"]["orders"]]  # list of all pending limit order IDs
3558        stopAll = [item["orderID"] for item in overview["stat"]["stopOrders"]]  # list of all stop order IDs
3559
3560        if limitAll and self.IsInLimitOrders(portfolio=overview):
3561            uLogger.debug("Closing all opened pending limit orders for the instrument with FIGI [{}]. Wait, please...")
3562            self.CloseOrders(orderIDs=self.GetLimitOrderIDs(portfolio=overview), allOrdersIDs=limitAll, allStopOrdersIDs=stopAll)
3563
3564        if stopAll and self.IsInStopOrders(portfolio=overview):
3565            uLogger.debug("Closing all opened stop orders for the instrument with FIGI [{}]. Wait, please...")
3566            self.CloseOrders(orderIDs=self.GetStopOrderIDs(portfolio=overview), allOrdersIDs=limitAll, allStopOrdersIDs=stopAll)
3567
3568        if self.IsInPortfolio(portfolio=overview):
3569            uLogger.debug("Closing all available (not blocked) opened trade for the instrument with FIGI [{}]. Wait, please...")
3570            self.CloseTrades(instruments=[instrument], portfolio=overview)
3571
3572    @staticmethod
3573    def ParseOrderParameters(operation, **inputParameters):
3574        """
3575        Parse input dictionary of strings with order parameters and return dictionary with parameters to open all orders.
3576
3577        :param operation: string "Buy" or "Sell".
3578        :param inputParameters: this is dict of strings that looks like this
3579               `{"lots": "L_int,...", "prices": "P_float,..."}` where
3580               "lots" key: one or more lot values (integer numbers) to open with every limit-order
3581               "prices" key: one or more prices to open limit-orders
3582               Counts of values in lots and prices lists must be equals!
3583        :return: list of dictionaries with all lots and prices to open orders that looks like this `[{"lot": lots_1, "price": price_1}, {...}, ...]`
3584        """
3585        # TODO: update order grid work with api v2
3586        pass
3587        # uLogger.debug("Input parameters: {}".format(inputParameters))
3588        #
3589        # if operation is None or not operation or operation not in ("Buy", "Sell"):
3590        #     uLogger.error("You must define operation type: 'Buy' or 'Sell'!")
3591        #     raise Exception("Incorrect value")
3592        #
3593        # if "l" in inputParameters.keys():
3594        #     inputParameters["lots"] = inputParameters.pop("l")
3595        #
3596        # if "p" in inputParameters.keys():
3597        #     inputParameters["prices"] = inputParameters.pop("p")
3598        #
3599        # if "lots" not in inputParameters.keys() or "prices" not in inputParameters.keys():
3600        #     uLogger.error("Both of 'lots' and 'prices' keys must be define to open grid orders!")
3601        #     raise Exception("Incorrect value")
3602        #
3603        # lots = [int(item.strip()) for item in inputParameters["lots"].split(",")]
3604        # prices = [float(item.strip()) for item in inputParameters["prices"].split(",")]
3605        #
3606        # if len(lots) != len(prices):
3607        #     uLogger.error("'lots' and 'prices' lists must have equal length of values!")
3608        #     raise Exception("Incorrect value")
3609        #
3610        # uLogger.debug("Extracted parameters for orders:")
3611        # uLogger.debug("lots = {}".format(lots))
3612        # uLogger.debug("prices = {}".format(prices))
3613        #
3614        # # list of dictionaries with order's parameters: [{"lot": lots_1, "price": price_1}, {...}, ...]
3615        # result = [{"lot": lots[item], "price": prices[item]} for item in range(len(prices))]
3616        # uLogger.debug("Order parameters: {}".format(result))
3617        #
3618        # return result
3619
3620    def IsInPortfolio(self, portfolio: dict = None) -> bool:
3621        """
3622        Checks if instrument is in the user's portfolio. Instrument must be defined by `ticker` (highly priority) or `figi`.
3623
3624        :param portfolio: dict with user's portfolio data. If `None`, then requests portfolio from `Overview()` method.
3625        :return: `True` if portfolio contains open position with given instrument, `False` otherwise.
3626        """
3627        result = False
3628        msg = "Instrument not defined!"
3629
3630        if portfolio is None or not portfolio:
3631            portfolio = self.Overview(show=False)
3632
3633        if self._ticker:
3634            uLogger.debug("Searching instrument with ticker [{}] throw opened positions list...".format(self._ticker))
3635            msg = "Instrument with ticker [{}] is not present in open positions".format(self._ticker)
3636
3637            for iType in TKS_INSTRUMENTS:
3638                for instrument in portfolio["stat"][iType]:
3639                    if instrument["ticker"] == self._ticker:
3640                        result = True
3641                        msg = "Instrument with ticker [{}] is present in open positions".format(self._ticker)
3642                        break
3643
3644        elif self._figi:
3645            uLogger.debug("Searching instrument with FIGI [{}] throw opened positions list...".format(self._figi))
3646            msg = "Instrument with FIGI [{}] is not present in open positions".format(self._figi)
3647
3648            for iType in TKS_INSTRUMENTS:
3649                for instrument in portfolio["stat"][iType]:
3650                    if instrument["figi"] == self._figi:
3651                        result = True
3652                        msg = "Instrument with FIGI [{}] is present in open positions".format(self._figi)
3653                        break
3654
3655        else:
3656            uLogger.warning("Instrument must be defined by `ticker` (highly priority) or `figi`!")
3657
3658        uLogger.debug(msg)
3659
3660        return result
3661
3662    def GetInstrumentFromPortfolio(self, portfolio: dict = None) -> dict:
3663        """
3664        Returns instrument from the user's portfolio if it presents there.
3665        Instrument must be defined by `ticker` (highly priority) or `figi`.
3666
3667        :param portfolio: dict with user's portfolio data. If `None`, then requests portfolio from `Overview()` method.
3668        :return: dict with instrument if portfolio contains open position with this instrument, `None` otherwise.
3669        """
3670        result = None
3671        msg = "Instrument not defined!"
3672
3673        if portfolio is None or not portfolio:
3674            portfolio = self.Overview(show=False)
3675
3676        if self._ticker:
3677            uLogger.debug("Searching instrument with ticker [{}] in opened positions...".format(self._ticker))
3678            msg = "Instrument with ticker [{}] is not present in open positions".format(self._ticker)
3679
3680            for iType in TKS_INSTRUMENTS:
3681                for instrument in portfolio["stat"][iType]:
3682                    if instrument["ticker"] == self._ticker:
3683                        result = instrument
3684                        msg = "Instrument with ticker [{}] and FIGI [{}] is present in open positions".format(self._ticker, instrument["figi"])
3685                        break
3686
3687        elif self._figi:
3688            uLogger.debug("Searching instrument with FIGI [{}] throwout opened positions...".format(self._figi))
3689            msg = "Instrument with FIGI [{}] is not present in open positions".format(self._figi)
3690
3691            for iType in TKS_INSTRUMENTS:
3692                for instrument in portfolio["stat"][iType]:
3693                    if instrument["figi"] == self._figi:
3694                        result = instrument
3695                        msg = "Instrument with ticker [{}] and FIGI [{}] is present in open positions".format(instrument["ticker"], self._figi)
3696                        break
3697
3698        else:
3699            uLogger.warning("Instrument must be defined by `ticker` (highly priority) or `figi`!")
3700
3701        uLogger.debug(msg)
3702
3703        return result
3704
3705    def IsInLimitOrders(self, portfolio: dict = None) -> bool:
3706        """
3707        Checks if instrument is in the limit orders list. Instrument must be defined by `ticker` (highly priority) or `figi`.
3708
3709        See also: `CloseAllByTicker()` and `CloseAllByFIGI()`.
3710
3711        :param portfolio: dict with user's portfolio data. If `None`, then requests portfolio from `Overview()` method.
3712        :return: `True` if limit orders list contains some limit orders for the instrument, `False` otherwise.
3713        """
3714        result = False
3715        msg = "Instrument not defined!"
3716
3717        if portfolio is None or not portfolio:
3718            portfolio = self.Overview(show=False)
3719
3720        if self._ticker:
3721            uLogger.debug("Searching instrument with ticker [{}] throw opened pending limit orders list...".format(self._ticker))
3722            msg = "Instrument with ticker [{}] is not present in opened pending limit orders list".format(self._ticker)
3723
3724            for instrument in portfolio["stat"]["orders"]:
3725                if instrument["ticker"] == self._ticker:
3726                    result = True
3727                    msg = "Instrument with ticker [{}] is present in limit orders list".format(self._ticker)
3728                    break
3729
3730        elif self._figi:
3731            uLogger.debug("Searching instrument with FIGI [{}] throw opened pending limit orders list...".format(self._figi))
3732            msg = "Instrument with FIGI [{}] is not present in opened pending limit orders list".format(self._figi)
3733
3734            for instrument in portfolio["stat"]["orders"]:
3735                if instrument["figi"] == self._figi:
3736                    result = True
3737                    msg = "Instrument with FIGI [{}] is present in opened pending limit orders list".format(self._figi)
3738                    break
3739
3740        else:
3741            uLogger.warning("Instrument must be defined by `ticker` (highly priority) or `figi`!")
3742
3743        uLogger.debug(msg)
3744
3745        return result
3746
3747    def GetLimitOrderIDs(self, portfolio: dict = None) -> list[str]:
3748        """
3749        Returns list with all `orderID`s of opened pending limit orders for the instrument.
3750        Instrument must be defined by `ticker` (highly priority) or `figi`.
3751
3752        See also: `CloseAllByTicker()` and `CloseAllByFIGI()`.
3753
3754        :param portfolio: dict with user's portfolio data. If `None`, then requests portfolio from `Overview()` method.
3755        :return: list with `orderID`s of limit orders.
3756        """
3757        result = []
3758        msg = "Instrument not defined!"
3759
3760        if portfolio is None or not portfolio:
3761            portfolio = self.Overview(show=False)
3762
3763        if self._ticker:
3764            uLogger.debug("Searching instrument with ticker [{}] throw opened pending limit orders list...".format(self._ticker))
3765            msg = "Instrument with ticker [{}] is not present in opened pending limit orders list".format(self._ticker)
3766
3767            for instrument in portfolio["stat"]["orders"]:
3768                if instrument["ticker"] == self._ticker:
3769                    result.append(instrument["orderID"])
3770
3771            if result:
3772                msg = "Instrument with ticker [{}] is present in limit orders list".format(self._ticker)
3773
3774        elif self._figi:
3775            uLogger.debug("Searching instrument with FIGI [{}] throw opened pending limit orders list...".format(self._figi))
3776            msg = "Instrument with FIGI [{}] is not present in opened pending limit orders list".format(self._figi)
3777
3778            for instrument in portfolio["stat"]["orders"]:
3779                if instrument["figi"] == self._figi:
3780                    result.append(instrument["orderID"])
3781
3782            if result:
3783                msg = "Instrument with FIGI [{}] is present in opened pending limit orders list".format(self._figi)
3784
3785        else:
3786            uLogger.warning("Instrument must be defined by `ticker` (highly priority) or `figi`!")
3787
3788        uLogger.debug(msg)
3789
3790        return result
3791
3792    def IsInStopOrders(self, portfolio: dict = None) -> bool:
3793        """
3794        Checks if instrument is in the stop orders list. Instrument must be defined by `ticker` (highly priority) or `figi`.
3795
3796        See also: `CloseAllByTicker()` and `CloseAllByFIGI()`.
3797
3798        :param portfolio: dict with user's portfolio data. If `None`, then requests portfolio from `Overview()` method.
3799        :return: `True` if stop orders list contains some stop orders for the instrument, `False` otherwise.
3800        """
3801        result = False
3802        msg = "Instrument not defined!"
3803
3804        if portfolio is None or not portfolio:
3805            portfolio = self.Overview(show=False)
3806
3807        if self._ticker:
3808            uLogger.debug("Searching instrument with ticker [{}] throw opened stop orders list...".format(self._ticker))
3809            msg = "Instrument with ticker [{}] is not present in opened stop orders list".format(self._ticker)
3810
3811            for instrument in portfolio["stat"]["stopOrders"]:
3812                if instrument["ticker"] == self._ticker:
3813                    result = True
3814                    msg = "Instrument with ticker [{}] is present in stop orders list".format(self._ticker)
3815                    break
3816
3817        elif self._figi:
3818            uLogger.debug("Searching instrument with FIGI [{}] throw opened stop orders list...".format(self._figi))
3819            msg = "Instrument with FIGI [{}] is not present in opened stop orders list".format(self._figi)
3820
3821            for instrument in portfolio["stat"]["stopOrders"]:
3822                if instrument["figi"] == self._figi:
3823                    result = True
3824                    msg = "Instrument with FIGI [{}] is present in opened stop orders list".format(self._figi)
3825                    break
3826
3827        else:
3828            uLogger.warning("Instrument must be defined by `ticker` (highly priority) or `figi`!")
3829
3830        uLogger.debug(msg)
3831
3832        return result
3833
3834    def GetStopOrderIDs(self, portfolio: dict = None) -> list[str]:
3835        """
3836        Returns list with all `orderID`s of opened stop orders for the instrument.
3837        Instrument must be defined by `ticker` (highly priority) or `figi`.
3838
3839        See also: `CloseAllByTicker()` and `CloseAllByFIGI()`.
3840
3841        :param portfolio: dict with user's portfolio data. If `None`, then requests portfolio from `Overview()` method.
3842        :return: list with `orderID`s of stop orders.
3843        """
3844        result = []
3845        msg = "Instrument not defined!"
3846
3847        if portfolio is None or not portfolio:
3848            portfolio = self.Overview(show=False)
3849
3850        if self._ticker:
3851            uLogger.debug("Searching instrument with ticker [{}] throw opened stop orders list...".format(self._ticker))
3852            msg = "Instrument with ticker [{}] is not present in opened stop orders list".format(self._ticker)
3853
3854            for instrument in portfolio["stat"]["stopOrders"]:
3855                if instrument["ticker"] == self._ticker:
3856                    result.append(instrument["orderID"])
3857
3858            if result:
3859                msg = "Instrument with ticker [{}] is present in stop orders list".format(self._ticker)
3860
3861        elif self._figi:
3862            uLogger.debug("Searching instrument with FIGI [{}] throw opened stop orders list...".format(self._figi))
3863            msg = "Instrument with FIGI [{}] is not present in opened stop orders list".format(self._figi)
3864
3865            for instrument in portfolio["stat"]["stopOrders"]:
3866                if instrument["figi"] == self._figi:
3867                    result.append(instrument["orderID"])
3868
3869            if result:
3870                msg = "Instrument with FIGI [{}] is present in opened stop orders list".format(self._figi)
3871
3872        else:
3873            uLogger.warning("Instrument must be defined by `ticker` (highly priority) or `figi`!")
3874
3875        uLogger.debug(msg)
3876
3877        return result
3878
3879    def RequestLimits(self) -> dict:
3880        """
3881        Method for obtaining the available funds for withdrawal for current `accountId`.
3882
3883        See also:
3884        - REST API for limits: https://tinkoff.github.io/investAPI/swagger-ui/#/OperationsService/OperationsService_GetWithdrawLimits
3885        - `OverviewLimits()` method
3886
3887        :return: dict with raw data from server that contains free funds for withdrawal. Example of dict:
3888                 `{"money": [{"currency": "rub", "units": "100", "nano": 290000000}, {...}], "blocked": [...], "blockedGuarantee": [...]}`.
3889                 Here `money` is an array of portfolio currency positions, `blocked` is an array of blocked currency
3890                 positions of the portfolio and `blockedGuarantee` is locked money under collateral for futures.
3891        """
3892        if self.accountId is None or not self.accountId:
3893            uLogger.error("Variable `accountId` must be defined for using this method!")
3894            raise Exception("Account ID required")
3895
3896        uLogger.debug("Requesting current available funds for withdrawal. Wait, please...")
3897
3898        self.body = str({"accountId": self.accountId})
3899        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.OperationsService/GetWithdrawLimits"
3900        rawLimits = self.SendAPIRequest(portfolioURL, reqType="POST")
3901
3902        if self.moreDebug:
3903            uLogger.debug("Records about available funds for withdrawal successfully received")
3904
3905        return rawLimits
3906
3907    def OverviewLimits(self, show: bool = False) -> dict:
3908        """
3909        Method for parsing and show table with available funds for withdrawal for current `accountId`.
3910
3911        See also: `RequestLimits()`.
3912
3913        :param show: if `False` then only dictionary returns, if `True` then also print withdrawal limits to log.
3914        :return: dict with raw parsed data from server and some calculated statistics about it.
3915        """
3916        if self.accountId is None or not self.accountId:
3917            uLogger.error("Variable `accountId` must be defined for using this method!")
3918            raise Exception("Account ID required")
3919
3920        rawLimits = self.RequestLimits()  # raw response with current available funds for withdrawal
3921
3922        view = {
3923            "rawLimits": rawLimits,
3924            "limits": {  # parsed data for every currency:
3925                "money": {  # this is an array of portfolio currency positions
3926                    item["currency"]: NanoToFloat(item["units"], item["nano"]) for item in rawLimits["money"]
3927                },
3928                "blocked": {  # this is an array of blocked currency
3929                    item["currency"]: NanoToFloat(item["units"], item["nano"]) for item in rawLimits["blocked"]
3930                },
3931                "blockedGuarantee": {  # this is locked money under collateral for futures
3932                    item["currency"]: NanoToFloat(item["units"], item["nano"]) for item in rawLimits["blockedGuarantee"]
3933                },
3934            },
3935        }
3936
3937        # --- Prepare text table with limits in human-readable format:
3938        if show:
3939            info = [
3940                "# Withdrawal limits\n\n",
3941                "* **Actual on date:** [{} UTC]\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
3942                "* **Account ID:** [{}]\n".format(self.accountId),
3943            ]
3944
3945            if view["limits"]["money"]:
3946                info.extend([
3947                    "\n| Currencies | Total         | Available for withdrawal | Blocked for trade | Futures guarantee |\n",
3948                    "|------------|---------------|--------------------------|-------------------|-------------------|\n",
3949                ])
3950
3951            else:
3952                info.append("\nNo withdrawal limits\n")
3953
3954            for curr in view["limits"]["money"].keys():
3955                blocked = view["limits"]["blocked"][curr] if curr in view["limits"]["blocked"].keys() else 0
3956                blockedGuarantee = view["limits"]["blockedGuarantee"][curr] if curr in view["limits"]["blockedGuarantee"].keys() else 0
3957                availableMoney = view["limits"]["money"][curr] - (blocked + blockedGuarantee)
3958
3959                infoStr = "| {:<10} | {:<13} | {:<24} | {:<17} | {:<17} |\n".format(
3960                    "[{}]".format(curr),
3961                    "{:.2f}".format(view["limits"]["money"][curr]),
3962                    "{:.2f}".format(availableMoney),
3963                    "{:.2f}".format(view["limits"]["blocked"][curr]) if curr in view["limits"]["blocked"].keys() else "—",
3964                    "{:.2f}".format(view["limits"]["blockedGuarantee"][curr]) if curr in view["limits"]["blockedGuarantee"].keys() else "—",
3965                )
3966
3967                if curr == "rub":
3968                    info.insert(5, infoStr)  # hack: insert "rub" at the first position in table and after headers
3969
3970                else:
3971                    info.append(infoStr)
3972
3973            infoText = "".join(info)
3974
3975            uLogger.info(infoText)
3976
3977            if self.withdrawalLimitsFile:
3978                with open(self.withdrawalLimitsFile, "w", encoding="UTF-8") as fH:
3979                    fH.write(infoText)
3980
3981                uLogger.info("Client's withdrawal limits was saved to file: [{}]".format(os.path.abspath(self.withdrawalLimitsFile)))
3982
3983                if self.useHTMLReports:
3984                    htmlFilePath = self.withdrawalLimitsFile.replace(".md", ".html") if self.withdrawalLimitsFile.endswith(".md") else self.withdrawalLimitsFile + ".html"
3985                    with open(htmlFilePath, "w", encoding="UTF-8") as fH:
3986                        fH.write(Template(text=MAIN_INFO_TEMPLATE).render(mainTitle="Withdrawal limits", commonCSS=COMMON_CSS, markdown=infoText))
3987
3988                    uLogger.info("The report has also been converted to an HTML file: [{}]".format(os.path.abspath(htmlFilePath)))
3989
3990        return view
3991
3992    def RequestAccounts(self) -> dict:
3993        """
3994        Method for requesting all brokerage accounts (`accountId`s) of current user detected by `token`.
3995
3996        See also:
3997        - REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/UsersService/UsersService_GetAccounts
3998        - What does account fields mean: https://tinkoff.github.io/investAPI/users/#account
3999        - `OverviewUserInfo()` method
4000
4001        :return: dict with raw data from server that contains accounts info. Example of dict:
4002                 `{"accounts": [{"id": "20000xxxxx", "type": "ACCOUNT_TYPE_TINKOFF", "name": "TKSBrokerAPI account",
4003                   "status": "ACCOUNT_STATUS_OPEN", "openedDate": "2018-05-23T00:00:00Z",
4004                   "closedDate": "1970-01-01T00:00:00Z", "accessLevel": "ACCOUNT_ACCESS_LEVEL_FULL_ACCESS"}, ...]}`.
4005                 If `closedDate="1970-01-01T00:00:00Z"` it means that account is active now.
4006        """
4007        uLogger.debug("Requesting all brokerage accounts of current user detected by its token. Wait, please...")
4008
4009        self.body = str({})
4010        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.UsersService/GetAccounts"
4011        rawAccounts = self.SendAPIRequest(portfolioURL, reqType="POST")
4012
4013        if self.moreDebug:
4014            uLogger.debug("Records about available accounts successfully received")
4015
4016        return rawAccounts
4017
4018    def RequestUserInfo(self) -> dict:
4019        """
4020        Method for requesting common user's information.
4021
4022        See also:
4023        - REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/UsersService/UsersService_GetInfo
4024        - What does user info fields mean: https://tinkoff.github.io/investAPI/users/#getinforequest
4025        - What does `qualified_for_work_with` field mean: https://tinkoff.github.io/investAPI/faq_users/#qualified_for_work_with
4026        - `OverviewUserInfo()` method
4027
4028        :return: dict with raw data from server that contains user's information. Example of dict:
4029                 `{"premStatus": true, "qualStatus": false, "qualifiedForWorkWith": ["bond", "foreign_shares", "leverage",
4030                   "russian_shares", "structured_income_bonds"], "tariff": "premium"}`.
4031        """
4032        uLogger.debug("Requesting common user's information. Wait, please...")
4033
4034        self.body = str({})
4035        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.UsersService/GetInfo"
4036        rawUserInfo = self.SendAPIRequest(portfolioURL, reqType="POST")
4037
4038        if self.moreDebug:
4039            uLogger.debug("Records about current user successfully received")
4040
4041        return rawUserInfo
4042
4043    def RequestMarginStatus(self, accountId: str = None) -> dict:
4044        """
4045        Method for requesting margin calculation for defined account ID.
4046
4047        See also:
4048        - REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/UsersService/UsersService_GetMarginAttributes
4049        - What does margin fields mean: https://tinkoff.github.io/investAPI/users/#getmarginattributesresponse
4050        - `OverviewUserInfo()` method
4051
4052        :param accountId: string with numeric account ID. If `None`, then used class field `accountId`.
4053        :return: dict with raw data from server that contains margin calculation. If margin is disabled then returns empty dict.
4054                 Example of responses:
4055                 status code 400: `{"code": 3, "message": "account margin status is disabled", "description": "30051" }`, returns: `{}`.
4056                 status code 200: `{"liquidPortfolio": {"currency": "rub", "units": "7175", "nano": 560000000},
4057                                    "startingMargin": {"currency": "rub", "units": "6311", "nano": 840000000},
4058                                    "minimalMargin": {"currency": "rub", "units": "3155", "nano": 920000000},
4059                                    "fundsSufficiencyLevel": {"units": "1", "nano": 280000000},
4060                                    "amountOfMissingFunds": {"currency": "rub", "units": "-863", "nano": -720000000}}`.
4061        """
4062        if accountId is None or not accountId:
4063            if self.accountId is None or not self.accountId:
4064                uLogger.error("Variable `accountId` must be defined for using this method!")
4065                raise Exception("Account ID required")
4066
4067            else:
4068                accountId = self.accountId  # use `self.accountId` (main ID) by default
4069
4070        uLogger.debug("Requesting margin calculation for accountId [{}]. Wait, please...".format(accountId))
4071
4072        self.body = str({"accountId": accountId})
4073        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.UsersService/GetMarginAttributes"
4074        rawMargin = self.SendAPIRequest(portfolioURL, reqType="POST")
4075
4076        if rawMargin == {"code": 3, "message": "account margin status is disabled", "description": "30051"}:
4077            uLogger.debug("Server response: margin status is disabled for current accountId [{}]".format(accountId))
4078            rawMargin = {}
4079
4080        else:
4081            if self.moreDebug:
4082                uLogger.debug("Records with margin calculation for accountId [{}] successfully received".format(accountId))
4083
4084        return rawMargin
4085
4086    def RequestTariffLimits(self) -> dict:
4087        """
4088        Method for requesting limits of current tariff (connections, API methods etc.) of current user detected by `token`.
4089
4090        See also:
4091        - REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/UsersService/UsersService_GetUserTariff
4092        - What does fields in tariff mean: https://tinkoff.github.io/investAPI/users/#getusertariffrequest
4093        - Unary limit: https://tinkoff.github.io/investAPI/users/#unarylimit
4094        - Stream limit: https://tinkoff.github.io/investAPI/users/#streamlimit
4095        - `OverviewUserInfo()` method
4096
4097        :return: dict with raw data from server that contains limits of current tariff. Example of dict:
4098                 `{"unaryLimits": [{"limitPerMinute": 0, "methods": ["methods", "methods"]}, ...],
4099                   "streamLimits": [{"streams": ["streams", "streams"], "limit": 6}, ...]}`.
4100        """
4101        uLogger.debug("Requesting limits of current tariff. Wait, please...")
4102
4103        self.body = str({})
4104        portfolioURL = self.server + r"/tinkoff.public.invest.api.contract.v1.UsersService/GetUserTariff"
4105        rawTariffLimits = self.SendAPIRequest(portfolioURL, reqType="POST")
4106
4107        if self.moreDebug:
4108            uLogger.debug("Records with limits of current tariff successfully received")
4109
4110        return rawTariffLimits
4111
4112    def RequestBondCoupons(self, iJSON: dict) -> dict:
4113        """
4114        Requesting bond payment calendar from official placement date to maturity date. If these dates are unknown
4115        then requesting dates `"from": "1970-01-01T00:00:00.000Z"` and `"to": "2099-12-31T23:59:59.000Z"`.
4116        All dates are in UTC timezone.
4117
4118        REST API: https://tinkoff.github.io/investAPI/swagger-ui/#/InstrumentsService/InstrumentsService_GetBondCoupons
4119        Documentation:
4120        - request: https://tinkoff.github.io/investAPI/instruments/#getbondcouponsrequest
4121        - response: https://tinkoff.github.io/investAPI/instruments/#coupon
4122
4123        See also: `ExtendBondsData()`.
4124
4125        :param iJSON: raw json data of a bond from broker server, example `iJSON = self.iList["Bonds"][self._ticker]`
4126                      If raw iJSON is not data of bond then server returns an error [400] with message:
4127                      `{"code": 3, "message": "instrument type is not bond", "description": "30048"}`.
4128        :return: dictionary with bond payment calendar. Response example
4129                 `{"events": [{"figi": "TCS00A101YV8", "couponDate": "2023-07-26T00:00:00Z", "couponNumber": "12",
4130                   "fixDate": "2023-07-25T00:00:00Z", "payOneBond": {"currency": "rub", "units": "7", "nano": 170000000},
4131                   "couponType": "COUPON_TYPE_CONSTANT", "couponStartDate": "2023-04-26T00:00:00Z",
4132                   "couponEndDate": "2023-07-26T00:00:00Z", "couponPeriod": 91}, {...}, ...]}`
4133        """
4134        if iJSON["figi"] is None or not iJSON["figi"]:
4135            uLogger.error("FIGI must be defined for using this method!")
4136            raise Exception("FIGI required")
4137
4138        startDate = iJSON["placementDate"] if "placementDate" in iJSON.keys() else "1970-01-01T00:00:00.000Z"
4139        endDate = iJSON["maturityDate"] if "maturityDate" in iJSON.keys() else "2099-12-31T23:59:59.000Z"
4140
4141        uLogger.debug("Requesting bond payment calendar, {}FIGI: [{}], from: [{}], to: [{}]. Wait, please...".format(
4142            "ticker: [{}], ".format(iJSON["ticker"]) if "ticker" in iJSON.keys() else "",
4143            self._figi,
4144            startDate,
4145            endDate,
4146        ))
4147
4148        self.body = str({"figi": iJSON["figi"], "from": startDate, "to": endDate})
4149        calendarURL = self.server + r"/tinkoff.public.invest.api.contract.v1.InstrumentsService/GetBondCoupons"
4150        calendar = self.SendAPIRequest(calendarURL, reqType="POST")
4151
4152        if calendar == {"code": 3, "message": "instrument type is not bond", "description": "30048"}:
4153            uLogger.warning("Instrument type is not bond!")
4154
4155        else:
4156            if self.moreDebug:
4157                uLogger.debug("Records about bond payment calendar successfully received")
4158
4159        return calendar
4160
4161    def ExtendBondsData(self, instruments: list[str], xlsx: bool = False) -> pd.DataFrame:
4162        """
4163        Requests jsons with raw bonds data for every ticker or FIGI in instruments list and transform it to the wider
4164        Pandas DataFrame with more information about bonds: main info, current prices, bond payment calendar,
4165        coupon yields, current yields and some statistics etc.
4166
4167        WARNING! This is too long operation if a lot of bonds requested from broker server.
4168
4169        See also: `ShowInstrumentInfo()`, `CreateBondsCalendar()`, `ShowBondsCalendar()`, `RequestBondCoupons()`.
4170
4171        :param instruments: list of strings with tickers or FIGIs.
4172        :param xlsx: if True then also exports Pandas DataFrame to xlsx-file `bondsXLSXFile`, default `ext-bonds.xlsx`,
4173                     for further used by data scientists or stock analytics.
4174        :return: wider Pandas DataFrame with more full and calculated data about bonds, than raw response from broker.
4175                 In XLSX-file and Pandas DataFrame fields mean:
4176                 - main info about bond: https://tinkoff.github.io/investAPI/instruments/#bond
4177                 - info about coupon: https://tinkoff.github.io/investAPI/instruments/#coupon
4178        """
4179        if instruments is None or not instruments:
4180            uLogger.error("List of tickers or FIGIs must be defined for using this method!")
4181            raise Exception("Ticker or FIGI required")
4182
4183        if isinstance(instruments, str):
4184            instruments = [instruments]
4185
4186        uniqueInstruments = self.GetUniqueFIGIs(instruments)
4187
4188        uLogger.debug("Requesting raw bonds calendar from server, transforming and extending it. Wait, please...")
4189
4190        iCount = len(uniqueInstruments)
4191        tooLong = iCount >= 20
4192        if tooLong:
4193            uLogger.warning("You requested a lot of bonds! Operation will takes more time. Wait, please...")
4194
4195        bonds = None
4196        for i, self._figi in enumerate(uniqueInstruments):
4197            instrument = self.SearchByFIGI(requestPrice=False)  # raw data about instrument from server
4198
4199            if "type" in instrument.keys() and instrument["type"] == "Bonds":
4200                # raw bond data from server where fields mean: https://tinkoff.github.io/investAPI/instruments/#bond
4201                rawBond = self.SearchByFIGI(requestPrice=True)
4202
4203                # Widen raw data with UTC current time (iData["actualDateTime"]):
4204                actualDate = datetime.now(tzutc())
4205                iData = {"actualDateTime": actualDate.strftime(TKS_DATE_TIME_FORMAT)} | rawBond
4206
4207                # Widen raw data with bond payment calendar (iData["rawCalendar"]):
4208                iData = iData | {"rawCalendar": self.RequestBondCoupons(iJSON=iData)}
4209
4210                # Replace some values with human-readable:
4211                iData["nominalCurrency"] = iData["nominal"]["currency"]
4212                iData["nominal"] = NanoToFloat(iData["nominal"]["units"], iData["nominal"]["nano"])
4213                iData["placementPrice"] = NanoToFloat(iData["placementPrice"]["units"], iData["placementPrice"]["nano"])
4214                iData["aciCurrency"] = iData["aciValue"]["currency"]
4215                iData["aciValue"] = NanoToFloat(iData["aciValue"]["units"], iData["aciValue"]["nano"])
4216                iData["issueSize"] = int(iData["issueSize"])
4217                iData["issueSizePlan"] = int(iData["issueSizePlan"])
4218                iData["tradingStatus"] = TKS_TRADING_STATUSES[iData["tradingStatus"]]
4219                iData["step"] = iData["step"] if "step" in iData.keys() else 0
4220                iData["realExchange"] = TKS_REAL_EXCHANGES[iData["realExchange"]]
4221                iData["klong"] = NanoToFloat(iData["klong"]["units"], iData["klong"]["nano"]) if "klong" in iData.keys() else 0
4222                iData["kshort"] = NanoToFloat(iData["kshort"]["units"], iData["kshort"]["nano"]) if "kshort" in iData.keys() else 0
4223                iData["dlong"] = NanoToFloat(iData["dlong"]["units"], iData["dlong"]["nano"]) if "dlong" in iData.keys() else 0
4224                iData["dshort"] = NanoToFloat(iData["dshort"]["units"], iData["dshort"]["nano"]) if "dshort" in iData.keys() else 0
4225                iData["dlongMin"] = NanoToFloat(iData["dlongMin"]["units"], iData["dlongMin"]["nano"]) if "dlongMin" in iData.keys() else 0
4226                iData["dshortMin"] = NanoToFloat(iData["dshortMin"]["units"], iData["dshortMin"]["nano"]) if "dshortMin" in iData.keys() else 0
4227
4228                # Widen raw data with price fields from `currentPrice` values (all prices are actual at `actualDateTime` date):
4229                iData["limitUpPercent"] = iData["currentPrice"]["limitUp"]  # max price on current day in percents of nominal
4230                iData["limitDownPercent"] = iData["currentPrice"]["limitDown"]  # min price on current day in percents of nominal
4231                iData["lastPricePercent"] = iData["currentPrice"]["lastPrice"]  # last price on market in percents of nominal
4232                iData["closePricePercent"] = iData["currentPrice"]["closePrice"]  # previous day close in percents of nominal
4233                iData["changes"] = iData["currentPrice"]["changes"]  # this is percent of changes between `currentPrice` and `lastPrice`
4234                iData["limitUp"] = iData["limitUpPercent"] * iData["nominal"] / 100  # max price on current day is `limitUpPercent` * `nominal`
4235                iData["limitDown"] = iData["limitDownPercent"] * iData["nominal"] / 100  # min price on current day is `limitDownPercent` * `nominal`
4236                iData["lastPrice"] = iData["lastPricePercent"] * iData["nominal"] / 100  # last price on market is `lastPricePercent` * `nominal`
4237                iData["closePrice"] = iData["closePricePercent"] * iData["nominal"] / 100  # previous day close is `closePricePercent` * `nominal`
4238                iData["changesDelta"] = iData["lastPrice"] - iData["closePrice"]  # this is delta between last deal price and last close
4239
4240                # Widen raw data with calendar data from `rawCalendar` values:
4241                calendarData = []
4242                if "events" in iData["rawCalendar"].keys():
4243                    for item in iData["rawCalendar"]["events"]:
4244                        calendarData.append({
4245                            "couponDate": item["couponDate"],
4246                            "couponNumber": int(item["couponNumber"]),
4247                            "fixDate": item["fixDate"] if "fixDate" in item.keys() else "",
4248                            "payCurrency": item["payOneBond"]["currency"],
4249                            "payOneBond": NanoToFloat(item["payOneBond"]["units"], item["payOneBond"]["nano"]),
4250                            "couponType": TKS_COUPON_TYPES[item["couponType"]],
4251                            "couponStartDate": item["couponStartDate"],
4252                            "couponEndDate": item["couponEndDate"],
4253                            "couponPeriod": item["couponPeriod"],
4254                        })
4255
4256                    # if maturity date is unknown then uses the latest date in bond payment calendar for it:
4257                    if "maturityDate" not in iData.keys():
4258                        iData["maturityDate"] = datetime.strptime(calendarData[0]["couponDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()).strftime(TKS_DATE_TIME_FORMAT) if calendarData else ""
4259
4260                # Widen raw data with Coupon Rate.
4261                # This is sum of all coupon payments divided on nominal price and expire days sum and then multiple on 365 days and 100%:
4262                iData["sumCoupons"] = sum([coupon["payOneBond"] for coupon in calendarData])
4263                iData["periodDays"] = sum([coupon["couponPeriod"] for coupon in calendarData])
4264                iData["couponsYield"] = 100 * 365 * (iData["sumCoupons"] / iData["nominal"]) / iData["periodDays"] if iData["nominal"] != 0 and iData["periodDays"] != 0 else 0.
4265
4266                # Widen raw data with Yield to Maturity (YTM) on current date.
4267                # This is sum of all stayed coupons to maturity minus ACI and divided on current bond price and then multiple on stayed days and 100%:
4268                maturityDate = datetime.strptime(iData["maturityDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()) if iData["maturityDate"] else None
4269                iData["daysToMaturity"] = (maturityDate - actualDate).days if iData["maturityDate"] else None
4270                iData["sumLastCoupons"] = sum([coupon["payOneBond"] for coupon in calendarData if datetime.strptime(coupon["couponDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()) > actualDate])
4271                iData["lastPayments"] = iData["sumLastCoupons"] - iData["aciValue"]  # sum of all last coupons minus current ACI value
4272                iData["currentYield"] = 100 * 365 * (iData["lastPayments"] / iData["lastPrice"]) / iData["daysToMaturity"] if iData["lastPrice"] != 0 and iData["daysToMaturity"] != 0 else 0.
4273
4274                iData["calendar"] = calendarData  # adds calendar at the end
4275
4276                # Remove not used data:
4277                iData.pop("uid")
4278                iData.pop("positionUid")
4279                iData.pop("currentPrice")
4280                iData.pop("rawCalendar")
4281
4282                colNames = list(iData.keys())
4283                if bonds is None:
4284                    bonds = pd.DataFrame(data=pd.DataFrame.from_records(data=[iData], columns=colNames))
4285
4286                else:
4287                    bonds = pd.concat([bonds, pd.DataFrame.from_records(data=[iData], columns=colNames)], axis=0, ignore_index=True)
4288
4289            else:
4290                uLogger.warning("Instrument is not a bond!")
4291
4292            processed = round(100 * (i + 1) / iCount, 1)
4293            if tooLong and processed % 5 == 0:
4294                uLogger.info("{}% processed [{} / {}]...".format(round(processed), i + 1, iCount))
4295
4296            else:
4297                uLogger.debug("{}% bonds processed [{} / {}]...".format(processed, i + 1, iCount))
4298
4299        bonds.index = bonds["ticker"].tolist()  # replace indexes with ticker names
4300
4301        # Saving bonds from Pandas DataFrame to XLSX sheet:
4302        if xlsx and self.bondsXLSXFile:
4303            with pd.ExcelWriter(
4304                    path=self.bondsXLSXFile,
4305                    date_format=TKS_DATE_FORMAT,
4306                    datetime_format=TKS_DATE_TIME_FORMAT,
4307                    mode="w",
4308            ) as writer:
4309                bonds.to_excel(
4310                    writer,
4311                    sheet_name="Extended bonds data",
4312                    index=True,
4313                    encoding="UTF-8",
4314                    freeze_panes=(1, 1),
4315                )  # saving as XLSX-file with freeze first row and column as headers
4316
4317            uLogger.info("XLSX-file with extended bonds data for further used by data scientists or stock analytics: [{}]".format(os.path.abspath(self.bondsXLSXFile)))
4318
4319        return bonds
4320
4321    def CreateBondsCalendar(self, extBonds: pd.DataFrame, xlsx: bool = False) -> pd.DataFrame:
4322        """
4323        Creates bond payments calendar as Pandas DataFrame, and also save it to the XLSX-file, `calendar.xlsx` by default.
4324
4325        WARNING! This is too long operation if a lot of bonds requested from broker server.
4326
4327        See also: `ShowBondsCalendar()`, `ExtendBondsData()`.
4328
4329        :param extBonds: Pandas DataFrame object returns by `ExtendBondsData()` method and contains
4330                        extended information about bonds: main info, current prices, bond payment calendar,
4331                        coupon yields, current yields and some statistics etc.
4332                        If this parameter is `None` then used `figi` or `ticker` as bond name and then calculate `ExtendBondsData()`.
4333        :param xlsx: if True then also exports Pandas DataFrame to file `calendarFile` + `".xlsx"`, `calendar.xlsx` by default,
4334                     for further used by data scientists or stock analytics.
4335        :return: Pandas DataFrame with only bond payments calendar data. Fields mean: https://tinkoff.github.io/investAPI/instruments/#coupon
4336        """
4337        if extBonds is None or not isinstance(extBonds, pd.DataFrame) or extBonds.empty:
4338            extBonds = self.ExtendBondsData(instruments=[self._figi, self._ticker], xlsx=False)
4339
4340        uLogger.debug("Generating bond payments calendar data. Wait, please...")
4341
4342        colNames = ["Paid", "Payment date", "FIGI", "Ticker", "Name", "No.", "Value", "Currency", "Coupon type", "Period", "End registry date", "Coupon start date", "Coupon end date"]
4343        colID = ["paid", "couponDate", "figi", "ticker", "name", "couponNumber", "payOneBond", "payCurrency", "couponType", "couponPeriod", "fixDate", "couponStartDate", "couponEndDate"]
4344        calendar = None
4345        for bond in extBonds.iterrows():
4346            for item in bond[1]["calendar"]:
4347                cData = {
4348                    "paid": datetime.now(tzutc()) > datetime.strptime(item["couponDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()),
4349                    "couponDate": item["couponDate"],
4350                    "figi": bond[1]["figi"],
4351                    "ticker": bond[1]["ticker"],
4352                    "name": bond[1]["name"],
4353                    "couponNumber": item["couponNumber"],
4354                    "payOneBond": item["payOneBond"],
4355                    "payCurrency": item["payCurrency"],
4356                    "couponType": item["couponType"],
4357                    "couponPeriod": item["couponPeriod"],
4358                    "fixDate": item["fixDate"],
4359                    "couponStartDate": item["couponStartDate"],
4360                    "couponEndDate": item["couponEndDate"],
4361                }
4362
4363                if calendar is None:
4364                    calendar = pd.DataFrame(data=pd.DataFrame.from_records(data=[cData], columns=colID))
4365
4366                else:
4367                    calendar = pd.concat([calendar, pd.DataFrame.from_records(data=[cData], columns=colID)], axis=0, ignore_index=True)
4368
4369        if calendar is not None:
4370            calendar = calendar.sort_values(by=["couponDate"], axis=0, ascending=True)  # sort all payments for all bonds by payment date
4371
4372            # Saving calendar from Pandas DataFrame to XLSX sheet:
4373            if xlsx:
4374                xlsxCalendarFile = self.calendarFile.replace(".md", ".xlsx") if self.calendarFile.endswith(".md") else self.calendarFile + ".xlsx"
4375
4376                with pd.ExcelWriter(
4377                        path=xlsxCalendarFile,
4378                        date_format=TKS_DATE_FORMAT,
4379                        datetime_format=TKS_DATE_TIME_FORMAT,
4380                        mode="w",
4381                ) as writer:
4382                    humanReadable = calendar.copy(deep=True)
4383                    humanReadable["couponDate"] = humanReadable["couponDate"].apply(lambda x: x.split("T")[0])
4384                    humanReadable["fixDate"] = humanReadable["fixDate"].apply(lambda x: x.split("T")[0])
4385                    humanReadable["couponStartDate"] = humanReadable["couponStartDate"].apply(lambda x: x.split("T")[0])
4386                    humanReadable["couponEndDate"] = humanReadable["couponEndDate"].apply(lambda x: x.split("T")[0])
4387                    humanReadable.columns = colNames  # human-readable column names
4388
4389                    humanReadable.to_excel(
4390                        writer,
4391                        sheet_name="Bond payments calendar",
4392                        index=False,
4393                        encoding="UTF-8",
4394                        freeze_panes=(1, 2),
4395                    )  # saving as XLSX-file with freeze first row and column as headers
4396
4397                    del humanReadable  # release df in memory
4398
4399                uLogger.info("XLSX-file with bond payments calendar for further used by data scientists or stock analytics: [{}]".format(os.path.abspath(xlsxCalendarFile)))
4400
4401        return calendar
4402
4403    def ShowBondsCalendar(self, extBonds: pd.DataFrame, show: bool = True) -> str:
4404        """
4405        Show bond payments calendar as a table. One row in input `bonds` dataframe contains one bond.
4406        Also, creates Markdown file with calendar data, `calendar.md` by default.
4407
4408        See also: `ShowInstrumentInfo()`, `RequestBondCoupons()`, `CreateBondsCalendar()` and `ExtendBondsData()`.
4409
4410        :param extBonds: Pandas DataFrame object returns by `ExtendBondsData()` method and contains
4411                        extended information about bonds: main info, current prices, bond payment calendar,
4412                        coupon yields, current yields and some statistics etc.
4413                        If this parameter is `None` then used `figi` or `ticker` as bond name and then calculate `ExtendBondsData()`.
4414        :param show: if `True` then also printing bonds payment calendar to the console,
4415                     otherwise save to file `calendarFile` only. `False` by default.
4416        :return: multilines text in Markdown format with bonds payment calendar as a table.
4417        """
4418        if extBonds is None or not isinstance(extBonds, pd.DataFrame) or extBonds.empty:
4419            extBonds = self.ExtendBondsData(instruments=[self._figi, self._ticker], xlsx=False)
4420
4421        infoText = "# Bond payments calendar\n\n"
4422
4423        calendar = self.CreateBondsCalendar(extBonds, xlsx=True)  # generate Pandas DataFrame with full calendar data
4424
4425        if not (calendar is None or calendar.empty):
4426            splitLine = "|       |                 |              |              |     |               |           |        |                   |\n"
4427
4428            info = [
4429                "* **Actual on date:** [{} UTC]\n\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
4430                "| Paid  | Payment date    | FIGI         | Ticker       | No. | Value         | Type      | Period | End registry date |\n",
4431                "|-------|-----------------|--------------|--------------|-----|---------------|-----------|--------|-------------------|\n",
4432            ]
4433
4434            newMonth = False
4435            notOneBond = calendar["figi"].nunique() > 1
4436            for i, bond in enumerate(calendar.iterrows()):
4437                if newMonth and notOneBond:
4438                    info.append(splitLine)
4439
4440                info.append(
4441                    "| {:<5} | {:<15} | {:<12} | {:<12} | {:<3} | {:<13} | {:<9} | {:<6} | {:<17} |\n".format(
4442                        "  √" if bond[1]["paid"] else "  —",
4443                        bond[1]["couponDate"].split("T")[0],
4444                        bond[1]["figi"],
4445                        bond[1]["ticker"],
4446                        bond[1]["couponNumber"],
4447                        "{} {}".format(
4448                            "{}".format(round(bond[1]["payOneBond"], 6)).rstrip("0").rstrip("."),
4449                            bond[1]["payCurrency"],
4450                        ),
4451                        bond[1]["couponType"],
4452                        bond[1]["couponPeriod"],
4453                        bond[1]["fixDate"].split("T")[0],
4454                    )
4455                )
4456
4457                if i < len(calendar.values) - 1:
4458                    curDate = datetime.strptime(bond[1]["couponDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc())
4459                    nextDate = datetime.strptime(calendar["couponDate"].values[i + 1], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc())
4460                    newMonth = False if curDate.month == nextDate.month else True
4461
4462                else:
4463                    newMonth = False
4464
4465            infoText += "".join(info)
4466
4467            if show:
4468                uLogger.info("{}".format(infoText))
4469
4470            if self.calendarFile is not None:
4471                with open(self.calendarFile, "w", encoding="UTF-8") as fH:
4472                    fH.write(infoText)
4473
4474                uLogger.info("Bond payments calendar was saved to file: [{}]".format(os.path.abspath(self.calendarFile)))
4475
4476                if self.useHTMLReports:
4477                    htmlFilePath = self.calendarFile.replace(".md", ".html") if self.calendarFile.endswith(".md") else self.calendarFile + ".html"
4478                    with open(htmlFilePath, "w", encoding="UTF-8") as fH:
4479                        fH.write(Template(text=MAIN_INFO_TEMPLATE).render(mainTitle="Bond payments calendar", commonCSS=COMMON_CSS, markdown=infoText))
4480
4481                    uLogger.info("The report has also been converted to an HTML file: [{}]".format(os.path.abspath(htmlFilePath)))
4482
4483        else:
4484            infoText += "No data\n"
4485
4486        return infoText
4487
4488    def OverviewAccounts(self, show: bool = False) -> dict:
4489        """
4490        Method for parsing and show simple table with all available user accounts.
4491
4492        See also: `RequestAccounts()` and `OverviewUserInfo()` methods.
4493
4494        :param show: if `False` then only dictionary with accounts data returns, if `True` then also print it to log.
4495        :return: dict with parsed accounts data received from `RequestAccounts()` method. Example of dict:
4496                 `view = {"rawAccounts": {rawAccounts from RequestAccounts() method...},
4497                          "stat": {"accountId string": {"type": "Tinkoff brokerage account", "name": "Test - 1",
4498                                                        "status": "Opened and active account", "opened": "2018-05-23 00:00:00",
4499                                                        "closed": "—", "access": "Full access" }, ...}}`
4500        """
4501        rawAccounts = self.RequestAccounts()  # Raw responses with accounts
4502
4503        # This is an array of dict with user accounts, its `accountId`s and some parsed data:
4504        accounts = {
4505            item["id"]: {
4506                "type": TKS_ACCOUNT_TYPES[item["type"]],
4507                "name": item["name"],
4508                "status": TKS_ACCOUNT_STATUSES[item["status"]],
4509                "opened": datetime.strptime(item["openedDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT),
4510                "closed": datetime.strptime(item["closedDate"], TKS_DATE_TIME_FORMAT).replace(tzinfo=tzutc()).astimezone(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT) if item["closedDate"] != "1970-01-01T00:00:00Z" else "—",
4511                "access": TKS_ACCESS_LEVELS[item["accessLevel"]],
4512            } for item in rawAccounts["accounts"]
4513        }
4514
4515        # Raw and parsed data with some fields replaced in "stat" section:
4516        view = {
4517            "rawAccounts": rawAccounts,
4518            "stat": accounts,
4519        }
4520
4521        # --- Prepare simple text table with only accounts data in human-readable format:
4522        if show:
4523            info = [
4524                "# User accounts\n\n",
4525                "* **Actual date:** [{} UTC]\n\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
4526                "| Account ID   | Type                      | Status                    | Name                           |\n",
4527                "|--------------|---------------------------|---------------------------|--------------------------------|\n",
4528            ]
4529
4530            for account in view["stat"].keys():
4531                info.extend([
4532                    "| {:<12} | {:<25} | {:<25} | {:<30} |\n".format(
4533                        account,
4534                        view["stat"][account]["type"],
4535                        view["stat"][account]["status"],
4536                        view["stat"][account]["name"],
4537                    )
4538                ])
4539
4540            infoText = "".join(info)
4541
4542            uLogger.info(infoText)
4543
4544            if self.userAccountsFile:
4545                with open(self.userAccountsFile, "w", encoding="UTF-8") as fH:
4546                    fH.write(infoText)
4547
4548                uLogger.info("User accounts were saved to file: [{}]".format(os.path.abspath(self.userAccountsFile)))
4549
4550                if self.useHTMLReports:
4551                    htmlFilePath = self.userAccountsFile.replace(".md", ".html") if self.userAccountsFile.endswith(".md") else self.userAccountsFile + ".html"
4552                    with open(htmlFilePath, "w", encoding="UTF-8") as fH:
4553                        fH.write(Template(text=MAIN_INFO_TEMPLATE).render(mainTitle="User accounts", commonCSS=COMMON_CSS, markdown=infoText))
4554
4555                    uLogger.info("The report has also been converted to an HTML file: [{}]".format(os.path.abspath(htmlFilePath)))
4556
4557        return view
4558
4559    def OverviewUserInfo(self, show: bool = False) -> dict:
4560        """
4561        Method for parsing and show all available user's data (`accountId`s, common user information, margin status and tariff connections limit).
4562
4563        See also: `OverviewAccounts()`, `RequestAccounts()`, `RequestUserInfo()`, `RequestMarginStatus()` and `RequestTariffLimits()` methods.
4564
4565        :param show: if `False` then only dictionary returns, if `True` then also print user's data to log.
4566        :return: dict with raw parsed data from server and some calculated statistics about it.
4567        """
4568        overview = self.Overview(show=False)  # Request current user portfolio for the ability to calculate missing funds
4569        tmpTicker = self._ticker
4570        self._ticker = "RUB000UTSTOM"  # This instrument show in rub how much money cost current margin
4571        missing = self.GetInstrumentFromPortfolio(portfolio=overview)
4572        self._ticker = tmpTicker
4573
4574        rawUserInfo = self.RequestUserInfo()  # Raw response with common user info
4575        overviewAccount = self.OverviewAccounts(show=False)  # Raw and parsed accounts data
4576        rawAccounts = overviewAccount["rawAccounts"]  # Raw response with user accounts data
4577        accounts = overviewAccount["stat"]  # Dict with only statistics about user accounts
4578        rawMargins = {account: self.RequestMarginStatus(accountId=account) for account in accounts.keys()}  # Raw response with margin calculation for every account ID
4579        rawTariffLimits = self.RequestTariffLimits()  # Raw response with limits of current tariff
4580
4581        # This is dict with parsed common user data:
4582        userInfo = {
4583            "premium": "Yes" if rawUserInfo["premStatus"] else "No",
4584            "qualified": "Yes" if rawUserInfo["qualStatus"] else "No",
4585            "allowed": [TKS_QUALIFIED_TYPES[item] for item in rawUserInfo["qualifiedForWorkWith"]],
4586            "tariff": rawUserInfo["tariff"],
4587        }
4588
4589        # This is an array of dict with parsed margin statuses for every account IDs:
4590        margins = {}
4591        for accountId in accounts.keys():
4592            if rawMargins[accountId]:
4593                margins[accountId] = {
4594                    "currency": rawMargins[accountId]["liquidPortfolio"]["currency"],
4595                    "liquid": NanoToFloat(rawMargins[accountId]["liquidPortfolio"]["units"], rawMargins[accountId]["liquidPortfolio"]["nano"]),
4596                    "start": NanoToFloat(rawMargins[accountId]["startingMargin"]["units"], rawMargins[accountId]["startingMargin"]["nano"]),
4597                    "min": NanoToFloat(rawMargins[accountId]["minimalMargin"]["units"], rawMargins[accountId]["minimalMargin"]["nano"]),
4598                    "diff": NanoToFloat(rawMargins[accountId]["amountOfMissingFunds"]["units"], rawMargins[accountId]["amountOfMissingFunds"]["nano"]),
4599                    "level": NanoToFloat(rawMargins[accountId]["fundsSufficiencyLevel"]["units"], rawMargins[accountId]["fundsSufficiencyLevel"]["nano"]),
4600                    "missing": missing["volume"],
4601                }
4602
4603            else:
4604                margins[accountId] = {}  # Server response: margin status is disabled for current accountId
4605
4606        unary = {}  # unary-connection limits
4607        for item in rawTariffLimits["unaryLimits"]:
4608            if item["limitPerMinute"] in unary.keys():
4609                unary[item["limitPerMinute"]].extend(item["methods"])
4610
4611            else:
4612                unary[item["limitPerMinute"]] = item["methods"]
4613
4614        stream = {}  # stream-connection limits
4615        for item in rawTariffLimits["streamLimits"]:
4616            if item["limit"] in stream.keys():
4617                stream[item["limit"]].extend(item["streams"])
4618
4619            else:
4620                stream[item["limit"]] = item["streams"]
4621
4622        # This is dict with parsed limits of current tariff (connections, API methods etc.):
4623        limits = {
4624            "unary": unary,
4625            "stream": stream,
4626        }
4627
4628        # Raw and parsed data as an output result:
4629        view = {
4630            "rawUserInfo": rawUserInfo,
4631            "rawAccounts": rawAccounts,
4632            "rawMargins": rawMargins,
4633            "rawTariffLimits": rawTariffLimits,
4634            "stat": {
4635                "overview": overview,
4636                "userInfo": userInfo,
4637                "accounts": accounts,
4638                "margins": margins,
4639                "limits": limits,
4640            },
4641        }
4642
4643        # --- Prepare text table with user information in human-readable format:
4644        if show:
4645            info = [
4646                "# Full user information\n\n",
4647                "* **Actual date:** [{} UTC]\n\n".format(datetime.now(tzutc()).strftime(TKS_PRINT_DATE_TIME_FORMAT)),
4648                "## Common information\n\n",
4649                "* **Qualified user:** {}\n".format(view["stat"]["userInfo"]["qualified"]),
4650                "* **Tariff name:** {}\n".format(view["stat"]["userInfo"]["tariff"]),
4651                "* **Premium user:** {}\n".format(view["stat"]["userInfo"]["premium"]),
4652                "* **Allowed to work with instruments:**\n{}\n".format("".join(["  - {}\n".format(item) for item in view["stat"]["userInfo"]["allowed"]])),
4653                "\n## User accounts\n\n",
4654            ]
4655
4656            for account in view["stat"]["accounts"].keys():
4657                info.extend([
4658                    "### ID: [{}]\n\n".format(account),
4659                    "| Parameters           | Values                                                       |\n",
4660                    "|----------------------|--------------------------------------------------------------|\n",
4661                    "| Account type:        | {:<60} |\n".format(view["stat"]["accounts"][account]["type"]),
4662                    "| Account name:        | {:<60} |\n".format(view["stat"]["accounts"][account]["name"]),
4663                    "| Account status:      | {:<60} |\n".format(view["stat"]["accounts"][account]["status"]),
4664                    "| Access level:        | {:<60} |\n".format(view["stat"]["accounts"][account]["access"]),
4665                    "| Date opened:         | {:<60} |\n".format(view["stat"]["accounts"][account]["opened"]),
4666                    "| Date closed:         | {:<60} |\n".format(view["stat"]["accounts"][account]["closed"]),
4667                ])
4668
4669                if margins[account]:
4670                    info.extend([
4671                        "| Margin status:       | Enabled                                                      |\n",
4672                        "| - Liquid portfolio:  | {:<60} |\n".format("{} {}".format(margins[account]["liquid"], margins[account]["currency"])),
4673                        "| - Margin starting:   | {:<60} |\n".format("{} {}".format(margins[account]["start"], margins[account]["currency"])),
4674                        "| - Margin minimum:    | {:<60} |\n".format("{} {}".format(margins[account]["min"], margins[account]["currency"])),
4675                        "| - Margin difference: | {:<60} |\n".format("{} {}".format(margins[account]["diff"], margins[account]["currency"])),
4676                        "| - Sufficiency level: | {:<60} |\n".format("{:.2f} ({:.2f}%)".format(margins[account]["level"], margins[account]["level"] * 100)),
4677                        "| - Not covered funds: | {:<60} |\n\n".format("{:.2f} {}".format(margins[account]["missing"], margins[account]["currency"])),
4678                    ])
4679
4680                else:
4681                    info.append("| Margin status:       | Disabled                                                     |\n\n")
4682
4683            info.extend([
4684                "\n## Current user tariff limits\n",
4685                "\n### See also\n",
4686                "* Tinkoff limit policy: https://tinkoff.github.io/investAPI/limits/\n",
4687                "* Tinkoff Invest API: https://tinkoff.github.io/investAPI/\n",
4688                "  - More about REST API requests: https://tinkoff.github.io/investAPI/swagger-ui/\n",
4689                "  - More about gRPC requests for stream connections: https://tinkoff.github.io/investAPI/grpc/\n",
4690                "\n### Unary limits\n",
4691            ])
4692
4693            if unary:
4694                for key, values in sorted(unary.items()):
4695                    info.append("\n* Max requests per minute: {}\n".format(key))
4696
4697                    for value in values:
4698                        info.append("  - {}\n".format(value))
4699
4700            else:
4701                info.append("\nNot available\n")
4702
4703            info.append("\n### Stream limits\n")
4704
4705            if stream:
4706                for key, values in sorted(stream.items()):
4707                    info.append("\n* Max stream connections: {}\n".format(key))
4708
4709                    for value in values:
4710                        info.append("  - {}\n".format(value))
4711
4712            else:
4713                info.append("\nNot available\n")
4714
4715            infoText = "".join(info)
4716
4717            uLogger.info(infoText)
4718
4719            if self.userInfoFile:
4720                with open(self.userInfoFile, "w", encoding="UTF-8") as fH:
4721                    fH.write(infoText)
4722
4723                uLogger.info("User data was saved to file: [{}]".format(os.path.abspath(self.userInfoFile)))
4724
4725                if self.useHTMLReports:
4726                    htmlFilePath = self.userInfoFile.replace(".md", ".html") if self.userInfoFile.endswith(".md") else self.userInfoFile + ".html"
4727                    with open(htmlFilePath, "w", encoding="UTF-8") as fH:
4728                        fH.write(Template(text=MAIN_INFO_TEMPLATE).render(mainTitle="User info", commonCSS=COMMON_CSS, markdown=infoText))
4729
4730                    uLogger.info("The report has also been converted to an HTML file: [{}]".format(os.path.abspath(htmlFilePath)))
4731
4732        return view
4733
4734
4735class Args:
4736    """
4737    If `Main()` function is imported as module, then this class used to convert arguments from **kwargs as object.
4738    """
4739    def __init__(self, **kwargs):
4740        self.__dict__.update(kwargs)
4741
4742    def __getattr__(self, item):
4743        return None
4744
4745
4746def ParseArgs():
4747    """This function get and parse command line keys."""
4748    parser = ArgumentParser()  # command-line string parser
4749
4750    parser.description = "TKSBrokerAPI is a trading platform for automation on Python to simplify the implementation of trading scenarios and work with Tinkoff Invest API server via the REST protocol. See examples: https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md"
4751    parser.usage = "\n/as module/ python TKSBrokerAPI.py [some options] [one command]\n/as CLI tool/ tksbrokerapi [some options] [one command]"
4752
4753    # --- options:
4754
4755    parser.add_argument("--no-cache", action="store_true", default=False, help="Option: not use local cache `dump.json`, but update raw instruments data when starting the platform. `False` by default.")
4756    parser.add_argument("--token", type=str, help="Option: Tinkoff service's api key. If not set then used environment variable `TKS_API_TOKEN`. See how to use: https://tinkoff.github.io/investAPI/token/")
4757    parser.add_argument("--account-id", type=str, default=None, help="Option: string with an user numeric account ID in Tinkoff Broker. It can be found in any broker's reports (see the contract number). Also, this variable can be set from environment variable `TKS_ACCOUNT_ID`.")
4758
4759    parser.add_argument("--ticker", "-t", type=str, help="Option: instrument's ticker, e.g. `IBM`, `YNDX`, `GOOGL` etc. Use alias for `USD000UTSTOM` simple as `USD`, `EUR_RUB__TOM` as `EUR`.")
4760    parser.add_argument("--figi", "-f", type=str, help="Option: instrument's FIGI, e.g. `BBG006L8G4H1` (for `YNDX`).")
4761
4762    parser.add_argument("--depth", type=int, default=1, help="Option: Depth of Market (DOM) can be >=1, 1 by default.")
4763    parser.add_argument("--no-cancelled", "--no-canceled", action="store_true", default=False, help="Option: remove information about cancelled operations from the deals report by the `--deals` key. `False` by default.")
4764
4765    parser.add_argument("--output", type=str, default=None, help="Option: replace default paths to output files for some commands. If `None` then used default files.")
4766    parser.add_argument("--html", "--HTML", action="store_true", default=False, help="Option: if key present then TKSBrokerAPI generate also HTML reports from Markdown. False by default.")
4767
4768    parser.add_argument("--interval", type=str, default="hour", help="Option: available values are `1min`, `5min`, `15min`, `hour` and `day`. Used only with `--history` key. This is time period of one candle. Default: `hour` for every history candles.")
4769    parser.add_argument("--only-missing", action="store_true", default=False, help="Option: if history file define by `--output` key then add only last missing candles, do not request all history length. `False` by default.")
4770    parser.add_argument("--csv-sep", type=str, default=",", help="Option: separator if csv-file is used, `,` by default.")
4771
4772    parser.add_argument("--debug-level", "--log-level", "--verbosity", "-v", type=int, default=20, help="Option: showing STDOUT messages of minimal debug level, e.g. 10 = DEBUG, 20 = INFO, 30 = WARNING, 40 = ERROR, 50 = CRITICAL. INFO (20) by default.")
4773    parser.add_argument("--more", "--more-debug", action="store_true", default=False, help="Option: `--debug-level` key only switch log level verbosity, but in addition `--more` key enable all debug information, such as net request and response headers in all methods.")
4774
4775    # --- commands:
4776
4777    parser.add_argument("--version", "--ver", action="store_true", help="Action: shows current semantic version, looks like `major.minor.buildnumber`. If TKSBrokerAPI not installed via pip, then used local build number `.dev0`.")
4778
4779    parser.add_argument("--list", "-l", action="store_true", help="Action: get and print all available instruments and some information from broker server. Also, you can define `--output` key to save list of instruments to file, default: `instruments.md`.")
4780    parser.add_argument("--list-xlsx", "-x", action="store_true", help="Action: get all available instruments from server for current account and save raw data into xlsx-file for further used by data scientists or stock analytics, default: `dump.xlsx`.")
4781    parser.add_argument("--bonds-xlsx", "-b", type=str, nargs="*", help="Action: get all available bonds if only key present or list of bonds with FIGIs or tickers and transform it to the wider Pandas DataFrame with more information about bonds: main info, current prices, bonds payment calendar, coupon yields, current yields and some statistics etc. And then export data to XLSX-file, default: `ext-bonds.xlsx` or you can change it with `--output` key. WARNING! This is too long operation if a lot of bonds requested from broker server.")
4782    parser.add_argument("--search", "-s", type=str, nargs=1, help="Action: search for an instruments by part of the name, ticker or FIGI. Also, you can define `--output` key to save results to file, default: `search-results.md`.")
4783    parser.add_argument("--info", "-i", action="store_true", help="Action: get information from broker server about instrument by it's ticker or FIGI. `--ticker` key or `--figi` key must be defined!")
4784    parser.add_argument("--calendar", "-c", type=str, nargs="*", help="Action: show bonds payment calendar as a table. Calendar build for one or more tickers or FIGIs, or for all bonds if only key present. If the `--output` key present then calendar saves to file, default: `calendar.md`. Also, created XLSX-file with bond payments calendar for further used by data scientists or stock analytics, `calendar.xlsx` by default. WARNING! This is too long operation if a lot of bonds requested from broker server.")
4785    parser.add_argument("--price", action="store_true", help="Action: show actual price list for current instrument. Also, you can use `--depth` key. `--ticker` key or `--figi` key must be defined!")
4786    parser.add_argument("--prices", "-p", type=str, nargs="+", help="Action: get and print current prices for list of given instruments (by it's tickers or by FIGIs). WARNING! This is too long operation if you request a lot of instruments! Also, you can define `--output` key to save list of prices to file, default: `prices.md`.")
4787
4788    parser.add_argument("--overview", "-o", action="store_true", help="Action: shows all open positions, orders and some statistics. Also, you can define `--output` key to save this information to file, default: `overview.md`.")
4789    parser.add_argument("--overview-digest", action="store_true", help="Action: shows a short digest of the portfolio status. Also, you can define `--output` key to save this information to file, default: `overview-digest.md`.")
4790    parser.add_argument("--overview-positions", action="store_true", help="Action: shows only open positions. Also, you can define `--output` key to save this information to file, default: `overview-positions.md`.")
4791    parser.add_argument("--overview-orders", action="store_true", help="Action: shows only sections of open limits and stop orders. Also, you can define `--output` key to save orders to file, default: `overview-orders.md`.")
4792    parser.add_argument("--overview-analytics", action="store_true", help="Action: shows only the analytics section and the distribution of the portfolio by various categories. Also, you can define `--output` key to save this information to file, default: `overview-analytics.md`.")
4793    parser.add_argument("--overview-calendar", action="store_true", help="Action: shows only the bonds calendar section (if these present in portfolio). Also, you can define `--output` key to save this information to file, default: `overview-calendar.md`.")
4794
4795    parser.add_argument("--deals", "-d", type=str, nargs="*", help="Action: show all deals between two given dates. Start day may be an integer number: -1, -2, -3 days ago. Also, you can use keywords: `today`, `yesterday` (-1), `week` (-7), `month` (-30) and `year` (-365). Dates format must be: `%%Y-%%m-%%d`, e.g. 2020-02-03. With `--no-cancelled` key information about cancelled operations will be removed from the deals report. Also, you can define `--output` key to save all deals to file, default: `deals.md`.")
4796    parser.add_argument("--history", type=str, nargs="*", help="Action: get last history candles of the current instrument defined by `--ticker` or `--figi` (FIGI id) keys. History returned between two given dates: `start` and `end`. Minimum requested date in the past is `1970-01-01`. This action may be used together with the `--render-chart` key. Also, you can define `--output` key to save history candlesticks to file.")
4797    parser.add_argument("--load-history", type=str, help="Action: try to load history candles from given csv-file as a Pandas Dataframe and print it in to the console. This action may be used together with the `--render-chart` key.")
4798    parser.add_argument("--render-chart", type=str, help="Action: render candlesticks chart. This key may only used with `--history` or `--load-history` together. Action has 1 parameter with two possible string values: `interact` (`i`) or `non-interact` (`ni`).")
4799
4800    parser.add_argument("--trade", nargs="*", help="Action: universal action to open market position for defined ticker or FIGI. You must specify 1-5 parameters: [direction `Buy` or `Sell`] [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`]. See examples in readme.")
4801    parser.add_argument("--buy", nargs="*", help="Action: immediately open BUY market position at the current price for defined ticker or FIGI. You must specify 0-4 parameters: [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`].")
4802    parser.add_argument("--sell", nargs="*", help="Action: immediately open SELL market position at the current price for defined ticker or FIGI. You must specify 0-4 parameters: [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`].")
4803
4804    parser.add_argument("--order", nargs="*", help="Action: universal action to open limit or stop-order in any directions. You must specify 4-7 parameters: [direction `Buy` or `Sell`] [order type `Limit` or `Stop`] [lots] [target price] [maybe for stop-order: [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`]]. See examples in readme.")
4805    parser.add_argument("--buy-limit", type=float, nargs=2, help="Action: open pending BUY limit-order (below current price). You must specify only 2 parameters: [lots] [target price] to open BUY limit-order. If you try to create `Buy` limit-order above current price then broker immediately open `Buy` market order, such as if you do simple `--buy` operation!")
4806    parser.add_argument("--sell-limit", type=float, nargs=2, help="Action: open pending SELL limit-order (above current price). You must specify only 2 parameters: [lots] [target price] to open SELL limit-order. If you try to create `Sell` limit-order below current price then broker immediately open `Sell` market order, such as if you do simple `--sell` operation!")
4807    parser.add_argument("--buy-stop", nargs="*", help="Action: open BUY stop-order. You must specify at least 2 parameters: [lots] [target price] to open BUY stop-order. In additional you can specify 3 parameters for stop-order: [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`]. When current price will go up or down to target price value then broker opens a limit order. Stop loss order always executed by market price.")
4808    parser.add_argument("--sell-stop", nargs="*", help="Action: open SELL stop-order. You must specify at least 2 parameters: [lots] [target price] to open SELL stop-order. In additional you can specify 3 parameters for stop-order: [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%%Y-%%m-%%d %%H:%%M:%%S`]. When current price will go up or down to target price value then broker opens a limit order. Stop loss order always executed by market price.")
4809    # parser.add_argument("--buy-limit-order-grid", type=str, nargs="*", help="Action: open grid of pending BUY limit-orders (below current price). Parameters format: l(ots)=[L_int,...] p(rices)=[P_float,...]. Counts of values in lots and prices lists must be equals!")
4810    # parser.add_argument("--sell-limit-order-grid", type=str, nargs="*", help="Action: open grid of pending SELL limit-orders (above current price). Parameters format: l(ots)=[L_int,...] p(rices)=[P_float,...]. Counts of values in lots and prices lists must be equals!")
4811
4812    parser.add_argument("--close-order", "--cancel-order", type=str, nargs=1, help="Action: close only one order by it's `orderId` or `stopOrderId`. You can find out the meaning of these IDs using the key `--overview`.")
4813    parser.add_argument("--close-orders", "--cancel-orders", type=str, nargs="+", help="Action: close one or list of orders by it's `orderId` or `stopOrderId`. You can find out the meaning of these IDs using the key `--overview`.")
4814    parser.add_argument("--close-trade", "--cancel-trade", action="store_true", help="Action: close only one position for instrument defined by `--ticker` (high priority) or `--figi` keys, including for currencies tickers.")
4815    parser.add_argument("--close-trades", "--cancel-trades", type=str, nargs="+", help="Action: close positions for list of tickers or FIGIs, including for currencies tickers or FIGIs.")
4816    parser.add_argument("--close-all", "--cancel-all", type=str, nargs="*", help="Action: close all available (not blocked) opened trades and orders, excluding for currencies. Also you can select one or more keywords case insensitive to specify trades type: `orders`, `shares`, `bonds`, `etfs` and `futures`, but not `currencies`. Currency positions you must closes manually using `--buy`, `--sell`, `--close-trade` or `--close-trades` operations. If the `--close-all` key present with the `--ticker` or `--figi` keys, then positions and all open limit and stop orders for the specified instrument are closed.")
4817
4818    parser.add_argument("--limits", "--withdrawal-limits", "-w", action="store_true", help="Action: show table of funds available for withdrawal for current `accountId`. You can change `accountId` with the key `--account-id`. Also, you can define `--output` key to save this information to file, default: `limits.md`.")
4819    parser.add_argument("--user-info", "-u", action="store_true", help="Action: show all available user's data (`accountId`s, common user information, margin status and tariff connections limit). Also, you can define `--output` key to save this information to file, default: `user-info.md`.")
4820    parser.add_argument("--account", "--accounts", "-a", action="store_true", help="Action: show simple table with all available user accounts. Also, you can define `--output` key to save this information to file, default: `accounts.md`.")
4821
4822    cmdArgs = parser.parse_args()
4823    return cmdArgs
4824
4825
4826def Main(**kwargs):
4827    """
4828    Main function for work with TKSBrokerAPI in the console.
4829
4830    See examples:
4831    - in english: https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README_EN.md
4832    - in russian: https://github.com/Tim55667757/TKSBrokerAPI/blob/master/README.md
4833    """
4834    args = Args(**kwargs) if kwargs else ParseArgs()  # get and parse command-line parameters or use **kwarg parameters
4835
4836    if args.debug_level:
4837        uLogger.level = 10  # always debug level by default
4838        uLogger.handlers[0].level = args.debug_level  # level for STDOUT
4839
4840    exitCode = 0
4841    start = datetime.now(tzutc())
4842    uLogger.debug("=-" * 50)
4843    uLogger.debug(">>> TKSBrokerAPI module started at: [{}] UTC, it is [{}] local time".format(
4844        start.strftime(TKS_PRINT_DATE_TIME_FORMAT),
4845        start.astimezone(tzlocal()).strftime(TKS_PRINT_DATE_TIME_FORMAT),
4846    ))
4847
4848    # trying to calculate full current version:
4849    buildVersion = __version__
4850    try:
4851        v = version("tksbrokerapi")
4852        buildVersion = v if v.startswith(buildVersion) else buildVersion + ".dev0"  # set version as major.minor.dev0 if run as local build or local script
4853
4854    except Exception:
4855        buildVersion = __version__ + ".dev0"  # if an errors occurred then also set version as major.minor.dev0
4856
4857    uLogger.debug("TKSBrokerAPI major.minor.build version used: [{}]".format(buildVersion))
4858    uLogger.debug("Host CPU count: [{}]".format(CPU_COUNT))
4859
4860    try:
4861        if args.version:
4862            print("TKSBrokerAPI {}".format(buildVersion))
4863            uLogger.debug("User requested current TKSBrokerAPI major.minor.build version: [{}]".format(buildVersion))
4864
4865        else:
4866            # Init class for trading with Tinkoff Broker:
4867            trader = TinkoffBrokerServer(
4868                token=args.token,
4869                accountId=args.account_id,
4870                useCache=not args.no_cache,
4871            )
4872
4873            # --- set some options:
4874
4875            if args.more:
4876                trader.moreDebug = True
4877                uLogger.warning("More debug info mode is enabled! See network requests, responses and its headers in the full log or run TKSBrokerAPI platform with the `--verbosity 10` to show theres in console.")
4878
4879            if args.html:
4880                trader.useHTMLReports = True
4881
4882            if args.ticker:
4883                ticker = str(args.ticker).upper()  # Tickers may be upper case only
4884
4885                if ticker in trader.aliasesKeys:
4886                    trader.ticker = trader.aliases[ticker]  # Replace some tickers with its aliases
4887
4888                else:
4889                    trader.ticker = ticker
4890
4891            if args.figi:
4892                trader.figi = str(args.figi).upper()  # FIGIs may be upper case only
4893
4894            if args.depth is not None:
4895                trader.depth = args.depth
4896
4897            # --- do one command:
4898
4899            if args.list:
4900                if args.output is not None:
4901                    trader.instrumentsFile = args.output
4902
4903                trader.ShowInstrumentsInfo(show=True)
4904
4905            elif args.list_xlsx:
4906                trader.DumpInstrumentsAsXLSX(forceUpdate=False)
4907
4908            elif args.bonds_xlsx is not None:
4909                if args.output is not None:
4910                    trader.bondsXLSXFile = args.output
4911
4912                if len(args.bonds_xlsx) == 0:
4913                    trader.ExtendBondsData(instruments=trader.iList["Bonds"].keys(), xlsx=True)  # request bonds with all available tickers
4914
4915                else:
4916                    trader.ExtendBondsData(instruments=args.bonds_xlsx, xlsx=True)  # request list of given bonds
4917
4918            elif args.search:
4919                if args.output is not None:
4920                    trader.searchResultsFile = args.output
4921
4922                trader.SearchInstruments(pattern=args.search[0], show=True)
4923
4924            elif args.info:
4925                if not (args.ticker or args.figi):
4926                    uLogger.error("`--ticker` key or `--figi` key is required for this operation!")
4927                    raise Exception("Ticker or FIGI required")
4928
4929                if args.output is not None:
4930                    trader.infoFile = args.output
4931
4932                if args.ticker:
4933                    trader.SearchByTicker(requestPrice=True, show=True)  # show info and current prices by ticker name
4934
4935                else:
4936                    trader.SearchByFIGI(requestPrice=True, show=True)  # show info and current prices by FIGI id
4937
4938            elif args.calendar is not None:
4939                if args.output is not None:
4940                    trader.calendarFile = args.output
4941
4942                if len(args.calendar) == 0:
4943                    bondsData = trader.ExtendBondsData(instruments=trader.iList["Bonds"].keys(), xlsx=False)  # request bonds with all available tickers
4944
4945                else:
4946                    bondsData = trader.ExtendBondsData(instruments=args.calendar, xlsx=False)  # request list of given bonds
4947
4948                trader.ShowBondsCalendar(extBonds=bondsData, show=True)  # shows bonds payment calendar only
4949
4950            elif args.price:
4951                if not (args.ticker or args.figi):
4952                    uLogger.error("`--ticker` key or `--figi` key is required for this operation!")
4953                    raise Exception("Ticker or FIGI required")
4954
4955                trader.GetCurrentPrices(show=True)
4956
4957            elif args.prices is not None:
4958                if args.output is not None:
4959                    trader.pricesFile = args.output
4960
4961                trader.GetListOfPrices(instruments=args.prices, show=True)  # WARNING: too long wait for a lot of instruments prices
4962
4963            elif args.overview:
4964                if args.output is not None:
4965                    trader.overviewFile = args.output
4966
4967                trader.Overview(show=True, details="full")
4968
4969            elif args.overview_digest:
4970                if args.output is not None:
4971                    trader.overviewDigestFile = args.output
4972
4973                trader.Overview(show=True, details="digest")
4974
4975            elif args.overview_positions:
4976                if args.output is not None:
4977                    trader.overviewPositionsFile = args.output
4978
4979                trader.Overview(show=True, details="positions")
4980
4981            elif args.overview_orders:
4982                if args.output is not None:
4983                    trader.overviewOrdersFile = args.output
4984
4985                trader.Overview(show=True, details="orders")
4986
4987            elif args.overview_analytics:
4988                if args.output is not None:
4989                    trader.overviewAnalyticsFile = args.output
4990
4991                trader.Overview(show=True, details="analytics")
4992
4993            elif args.overview_calendar:
4994                if args.output is not None:
4995                    trader.overviewAnalyticsFile = args.output
4996
4997                trader.Overview(show=True, details="calendar")
4998
4999            elif args.deals is not None:
5000                if args.output is not None:
5001                    trader.reportFile = args.output
5002
5003                if 0 <= len(args.deals) < 3:
5004                    trader.Deals(
5005                        start=args.deals[0] if len(args.deals) >= 1 else None,
5006                        end=args.deals[1] if len(args.deals) == 2 else None,
5007                        show=True,  # Always show deals report in console
5008                        showCancelled=not args.no_cancelled,  # If --no-cancelled key then remove cancelled operations from the deals report. False by default.
5009                    )
5010
5011                else:
5012                    uLogger.error("You must specify 0-2 parameters: [DATE_START] [DATE_END]")
5013                    raise Exception("Incorrect value")
5014
5015            elif args.history is not None:
5016                if args.output is not None:
5017                    trader.historyFile = args.output
5018
5019                if 0 <= len(args.history) < 3:
5020                    dataReceived = trader.History(
5021                        start=args.history[0] if len(args.history) >= 1 else None,
5022                        end=args.history[1] if len(args.history) == 2 else None,
5023                        interval="hour" if args.interval is None or not args.interval else args.interval,
5024                        onlyMissing=False if args.only_missing is None or not args.only_missing else args.only_missing,
5025                        csvSep="," if args.csv_sep is None or not args.csv_sep else args.csv_sep,
5026                        show=True,  # shows all downloaded candles in console
5027                    )
5028
5029                    if args.render_chart is not None and dataReceived is not None:
5030                        iChart = False if args.render_chart.lower() == "ni" or args.render_chart.lower() == "non-interact" else True
5031
5032                        trader.ShowHistoryChart(
5033                            candles=dataReceived,
5034                            interact=iChart,
5035                            openInBrowser=False,  # False by default, to avoid issues with `permissions denied` to html-file.
5036                        )
5037
5038                else:
5039                    uLogger.error("You must specify 0-2 parameters: [DATE_START] [DATE_END]")
5040                    raise Exception("Incorrect value")
5041
5042            elif args.load_history is not None:
5043                histData = trader.LoadHistory(filePath=args.load_history)  # load data from file and show history in console
5044
5045                if args.render_chart is not None and histData is not None:
5046                    iChart = False if args.render_chart.lower() == "ni" or args.render_chart.lower() == "non-interact" else True
5047                    trader.ticker = os.path.basename(args.load_history)  # use filename as ticker name for PriceGenerator's chart
5048
5049                    trader.ShowHistoryChart(
5050                        candles=histData,
5051                        interact=iChart,
5052                        openInBrowser=False,  # False by default, to avoid issues with `permissions denied` to html-file.
5053                    )
5054
5055            elif args.trade is not None:
5056                if 1 <= len(args.trade) <= 5:
5057                    trader.Trade(
5058                        operation=args.trade[0],
5059                        lots=int(args.trade[1]) if len(args.trade) >= 2 else 1,
5060                        tp=float(args.trade[2]) if len(args.trade) >= 3 else 0.,
5061                        sl=float(args.trade[3]) if len(args.trade) >= 4 else 0.,
5062                        expDate=args.trade[4] if len(args.trade) == 5 else "Undefined",
5063                    )
5064
5065                else:
5066                    uLogger.error("You must specify 1-5 parameters to open trade: [direction `Buy` or `Sell`] [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%Y-%m-%d %H:%M:%S`]. See: `python TKSBrokerAPI.py --help`")
5067
5068            elif args.buy is not None:
5069                if 0 <= len(args.buy) <= 4:
5070                    trader.Buy(
5071                        lots=int(args.buy[0]) if len(args.buy) >= 1 else 1,
5072                        tp=float(args.buy[1]) if len(args.buy) >= 2 else 0.,
5073                        sl=float(args.buy[2]) if len(args.buy) >= 3 else 0.,
5074                        expDate=args.buy[3] if len(args.buy) == 4 else "Undefined",
5075                    )
5076
5077                else:
5078                    uLogger.error("You must specify 0-4 parameters to open buy position: [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%Y-%m-%d %H:%M:%S`]. See: `python TKSBrokerAPI.py --help`")
5079
5080            elif args.sell is not None:
5081                if 0 <= len(args.sell) <= 4:
5082                    trader.Sell(
5083                        lots=int(args.sell[0]) if len(args.sell) >= 1 else 1,
5084                        tp=float(args.sell[1]) if len(args.sell) >= 2 else 0.,
5085                        sl=float(args.sell[2]) if len(args.sell) >= 3 else 0.,
5086                        expDate=args.sell[3] if len(args.sell) == 4 else "Undefined",
5087                    )
5088
5089                else:
5090                    uLogger.error("You must specify 0-4 parameters to open sell position: [lots, >= 1] [take profit, >= 0] [stop loss, >= 0] [expiration date for TP/SL orders, Undefined|`%Y-%m-%d %H:%M:%S`]. See: `python TKSBrokerAPI.py --help`")
5091
5092            elif args.order:
5093                if 4 <= len(args.order) <= 7:
5094                    trader.Order(
5095                        operation=args.order[0],
5096                        orderType=args.order[1],
5097                        lots=int(args.order[2]),
5098                        targetPrice=float(args.order[3]),
5099                        limitPrice=float(args.order[4]) if len(args.order) >= 5 else 0.,
5100                        stopType=args.order[5] if len(args.order) >= 6 else "Limit",
5101                        expDate=args.order[6] if len(args.order) == 7 else "Undefined",
5102                    )
5103
5104                else:
5105                    uLogger.error("You must specify 4-7 parameters to open order: [direction `Buy` or `Sell`] [order type `Limit` or `Stop`] [lots] [target price] [maybe for stop-order: [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%Y-%m-%d %H:%M:%S`]]. See: `python TKSBrokerAPI.py --help`")
5106
5107            elif args.buy_limit:
5108                trader.BuyLimit(lots=int(args.buy_limit[0]), targetPrice=args.buy_limit[1])
5109
5110            elif args.sell_limit:
5111                trader.SellLimit(lots=int(args.sell_limit[0]), targetPrice=args.sell_limit[1])
5112
5113            elif args.buy_stop:
5114                if 2 <= len(args.buy_stop) <= 7:
5115                    trader.BuyStop(
5116                        lots=int(args.buy_stop[0]),
5117                        targetPrice=float(args.buy_stop[1]),
5118                        limitPrice=float(args.buy_stop[2]) if len(args.buy_stop) >= 3 else 0.,
5119                        stopType=args.buy_stop[3] if len(args.buy_stop) >= 4 else "Limit",
5120                        expDate=args.buy_stop[4] if len(args.buy_stop) == 5 else "Undefined",
5121                    )
5122
5123                else:
5124                    uLogger.error("You must specify 2-5 parameters for buy stop-order: [lots] [target price] [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%Y-%m-%d %H:%M:%S`]. See: `python TKSBrokerAPI.py --help`")
5125
5126            elif args.sell_stop:
5127                if 2 <= len(args.sell_stop) <= 7:
5128                    trader.SellStop(
5129                        lots=int(args.sell_stop[0]),
5130                        targetPrice=float(args.sell_stop[1]),
5131                        limitPrice=float(args.sell_stop[2]) if len(args.sell_stop) >= 3 else 0.,
5132                        stopType=args.sell_stop[3] if len(args.sell_stop) >= 4 else "Limit",
5133                        expDate=args.sell_stop[4] if len(args.sell_stop) == 5 else "Undefined",
5134                    )
5135
5136                else:
5137                    uLogger.error("You must specify 2-5 parameters for sell stop-order: [lots] [target price] [limit price, >= 0] [stop type, Limit|SL|TP] [expiration date, Undefined|`%Y-%m-%d %H:%M:%S`]. See: python TKSBrokerAPI.py --help")
5138
5139            # elif args.buy_order_grid is not None:
5140            #     # update order grid work with api v2
5141            #     if len(args.buy_order_grid) == 2:
5142            #         orderParams = trader.ParseOrderParameters(operation="Buy", **dict(kw.split('=') for kw in args.buy_order_grid))
5143            #
5144            #         for order in orderParams:
5145            #             trader.Order(operation="Buy", lots=order["lot"], price=order["price"])
5146            #
5147            #     else:
5148            #         uLogger.error("To open grid of pending BUY limit-orders (below current price) you must specified 2 parameters: l(ots)=[L_int,...] p(rices)=[P_float,...]. See: `python TKSBrokerAPI.py --help`")
5149            #
5150            # elif args.sell_order_grid is not None:
5151            #     # update order grid work with api v2
5152            #     if len(args.sell_order_grid) >= 2:
5153            #         orderParams = trader.ParseOrderParameters(operation="Sell", **dict(kw.split('=') for kw in args.sell_order_grid))
5154            #
5155            #         for order in orderParams:
5156            #             trader.Order(operation="Sell", lots=order["lot"], price=order["price"])
5157            #
5158            #     else:
5159            #         uLogger.error("To open grid of pending SELL limit-orders (above current price) you must specified 2 parameters: l(ots)=[L_int,...] p(rices)=[P_float,...]. See: `python TKSBrokerAPI.py --help`")
5160
5161            elif args.close_order is not None:
5162                trader.CloseOrders(args.close_order)  # close only one order
5163
5164            elif args.close_orders is not None:
5165                trader.CloseOrders(args.close_orders)  # close list of orders
5166
5167            elif args.close_trade:
5168                if not (args.ticker or args.figi):
5169                    uLogger.error("`--ticker` key or `--figi` key is required for this operation!")
5170                    raise Exception("Ticker or FIGI required")
5171
5172                if args.ticker:
5173                    trader.CloseTrades([str(args.ticker).upper()])  # close only one trade by ticker (priority)
5174
5175                else:
5176                    trader.CloseTrades([str(args.figi).upper()])  # close only one trade by FIGI
5177
5178            elif args.close_trades is not None:
5179                trader.CloseTrades(args.close_trades)  # close trades for list of tickers
5180
5181            elif args.close_all is not None:
5182                if args.ticker:
5183                    trader.CloseAllByTicker(instrument=str(args.ticker).upper())
5184
5185                elif args.figi:
5186                    trader.CloseAllByFIGI(instrument=str(args.figi).upper())
5187
5188                else:
5189                    trader.CloseAll(*args.close_all)
5190
5191            elif args.limits:
5192                if args.output is not None:
5193                    trader.withdrawalLimitsFile = args.output
5194
5195                trader.OverviewLimits(show=True)
5196
5197            elif args.user_info:
5198                if args.output is not None:
5199                    trader.userInfoFile = args.output
5200
5201                trader.OverviewUserInfo(show=True)
5202
5203            elif args.account:
5204                if args.output is not None:
5205                    trader.userAccountsFile = args.output
5206
5207                trader.OverviewAccounts(show=True)
5208
5209            else:
5210                uLogger.error("There is no command to execute! One of the possible commands must be selected. See help with `--help` key.")
5211                raise Exception("There is no command to execute")
5212
5213    except Exception:
5214        trace = tb.format_exc()
5215        for e in ["socket.gaierror", "nodename nor servname provided", "or not known", "NewConnectionError", "[Errno 8]", "Failed to establish a new connection"]:
5216            if e in trace:
5217                uLogger.error("Check your Internet connection! Failed to establish connection to broker server!")
5218                break
5219
5220        uLogger.debug(trace)
5221        uLogger.debug("Please, check issues or request a new one at https://github.com/Tim55667757/TKSBrokerAPI/issues")
5222        exitCode = 255  # an error occurred, must be open a ticket for this issue
5223
5224    finally:
5225        finish = datetime.now(tzutc())
5226
5227        if exitCode == 0:
5228            if args.more:
5229                uLogger.debug("All operations were finished success (summary code is 0).")
5230
5231        else:
5232            uLogger.error("An issue occurred with TKSBrokerAPI module! See full debug log in [{}] or run TKSBrokerAPI once again with the key `--debug-level 10`. Summary code: {}".format(
5233                os.path.abspath(uLog.defaultLogFile), exitCode,
5234            ))
5235
5236        uLogger.debug(">>> TKSBrokerAPI module work duration: [{}]".format(finish - start))
5237        uLogger.debug(">>> TKSBrokerAPI module finished: [{} UTC], it is [{}] local time".format(
5238            finish.strftime(TKS_PRINT_DATE_TIME_FORMAT),
5239            finish.astimezone(tzlocal()).strftime(TKS_PRINT_DATE_TIME_FORMAT),
5240        ))
5241        uLogger.debug("=-" * 50)
5242
5243        if not kwargs:
5244            sys.exit(exitCode)
5245
5246        else:
5247            return exitCode
5248
5249
5250if __name__ == "__main__":
5251    Main()